Class PublicRestUriHelper

java.lang.Object
de.xima.fc.api.rest.pub.common.uri.PublicRestUriHelper
public class PublicRestUriHelper extends Object
Helper class to generate URIs for the public generic REST API.
Since:
8.4.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getAttachmentBaseResourcePath

      public static String getAttachmentBaseResourcePath()
      Returns the base path for attachment resources.
      Returns:
      The base path for attachment resources.

    • getAttachmentResourcePath

      public static String getAttachmentResourcePath(Attachment attachment)
      Returns the path for an attachment resource.
      Parameters:
      attachment - The attachment.
      Returns:
      The path for the attachment resource.

    • getAuthenticatorsBaseResourcePath

      public static String getAuthenticatorsBaseResourcePath()
      Returns the base path for authenticator resources.
      Returns:
      The base path for authenticator resources.

    • getBaseResourcePath

      public static String getBaseResourcePath(de.xima.cmn.dao.interfaces.IEntity<?> entity)
      Returns the base path for resources of the given entity.
      Parameters:
      entity - The entity.
      Returns:
      The base path for resources of the given entity.
      Throws:
      NullPointerException - if entity is null.
      IllegalArgumentException - if entity is not a supported type.

    • getFormRecordAttachmentBaseResourcePath

      public static String getFormRecordAttachmentBaseResourcePath(UUID uuid)
      Returns the base path for form record attachment resources in the context of a form record.
      Parameters:
      uuid - The form record as context.
      Returns:
      The base path for form record attachment resources in the context of a form record.

    • getFormRecordBaseResourcePath

      public static String getFormRecordBaseResourcePath()
      Returns the base path for form record resources.
      Returns:
      The base path for form record resources.

    • getFormRecordChatBaseResourcePath

      public static String getFormRecordChatBaseResourcePath()
      Returns the base path for form record chat resources.
      Returns:
      The base path for form record chat resources.

    • getFormRecordChatBaseResourcePath

      public static String getFormRecordChatBaseResourcePath(UUID uuid)
      Returns the base path for form record chat resources in the context of a form record.
      Parameters:
      uuid - The form record as context.
      Returns:
      The base path for form record chat resources in the context of a form record.

    • getFormRecordChatMessagesPath

      public static String getFormRecordChatMessagesPath(UUID uuid)
      Returns the path for the messages of a specific form record chat.
      Parameters:
      uuid - The form record chat.
      Returns:
      The path for the messages of a specific form record chat.

    • getFormRecordChatResourcePath

      public static String getFormRecordChatResourcePath(UUID uuid)
      Returns the path for a form record chat resource.
      Parameters:
      uuid - The form record chat.
      Returns:
      The path for the form record chat resource.

    • getFormRecordMessageBaseResourcePath

      public static String getFormRecordMessageBaseResourcePath()
      Returns the base path for form record message resources.
      Returns:
      The base path for form record message resources.

    • getFormRecordMessageResourcePath

      public static String getFormRecordMessageResourcePath(UUID uuid)
      Returns the path for a form record message resource.
      Parameters:
      uuid - The form record message.
      Returns:
      The path for the form record message resource.

    • getFormRecordMessageUploadRequestBaseResourcePath

      public static String getFormRecordMessageUploadRequestBaseResourcePath(UUID uuid)
      Returns the base path for form record message upload request resources.
      Parameters:
      uuid - The form record message.
      Returns:
      The base path for form record message upload request resources.

    • getFormRecordResourcePath

      public static String getFormRecordResourcePath(Vorgang formRecord)
      Returns the path for a form record resource.
      Parameters:
      formRecord - The form record.
      Returns:
      The path for the form record resource.

    • getFormRecordResourcePathByUuid

      public static String getFormRecordResourcePathByUuid(String formRecordUuid)
      Returns the path for a form record resource.
      Parameters:
      formRecordUuid - The UUID of the form record.
      Returns:
      The path for the form record resource.

    • getFormRecordWorkflowTriggerBaseResourcePath

      public static String getFormRecordWorkflowTriggerBaseResourcePath(Vorgang formRecord, WorkflowTask task)
      Returns the base path for workflow trigger resources in the context of a form record.
      Parameters:
      formRecord - The form record as context.
      task - The workflow task.
      Returns:
      The base path for workflow trigger resources in the context of a form record.

    • getFormRecordWorkflowTriggerBaseResourcePathByTaskUuid

      public static String getFormRecordWorkflowTriggerBaseResourcePathByTaskUuid(Vorgang formRecord, String taskUuid)
      Returns the base path for workflow trigger resources in the context of a form record.
      Parameters:
      formRecord - The form record as context.
      taskUuid - The UUID of the workflow task.
      Returns:
      The base path for workflow trigger resources in the context of a form record.

    • getFormRecordWorkflowTriggerBaseResourcePathByUuid

      public static String getFormRecordWorkflowTriggerBaseResourcePathByUuid(String formRecordUuid, String taskUuid)
      Returns the base path for workflow trigger resources in the context of a form record.
      Parameters:
      formRecordUuid - The UUID of the form record.
      taskUuid - The UUID of the workflow task.
      Returns:
      The base path for workflow trigger resources in the context of a form record.

    • getFormRecordWorkflowTriggerResourcePath

      public static String getFormRecordWorkflowTriggerResourcePath(Vorgang formRecord, WorkflowTrigger trigger)
      Returns the path for a workflow trigger resource in the context of a form record.
      Parameters:
      formRecord - The form record as context.
      trigger - The workflow trigger.
      Returns:
      The path for the workflow trigger resource.

    • getProjectBaseResourcePath

      public static String getProjectBaseResourcePath(Mandant client)
      Returns the base path for project resources.
      Parameters:
      client - The client.
      Returns:
      The base path for project resources.

    • getProjectFileBaseResourcePath

      public static String getProjectFileBaseResourcePath(Projekt project)
      Returns the base path for project file resources.
      Parameters:
      project - The project.
      Returns:
      The base path for project file resources.

    • getProjectResourcePath

      public static String getProjectResourcePath(Projekt project)
      Returns the path for a project resource.
      Parameters:
      project - The project.
      Returns:
      The path for the project resource.

    • getUserPortalAuthenticatorsPath

      public static String getUserPortalAuthenticatorsPath(UserPortal userPortal)
      Returns the path for the authenticators of a user portal.
      Parameters:
      userPortal - The user portal.
      Returns:
      The path for the authenticators of a user portal.

    • getUserPortalBaseResourcePath

      public static String getUserPortalBaseResourcePath()
      Returns the base path for user portal resources.
      Returns:
      The base path for user portal resources.

    • getUserPortalFileBaseResourcePath

      public static String getUserPortalFileBaseResourcePath(UserPortalFile file)
      Returns the base path for a user portal file resource.
      Parameters:
      file - The user portal file.
      Returns:
      The base path for the user portal file resource.

    • getUserPortalFormsPath

      public static String getUserPortalFormsPath(UserPortal userPortal)
      Returns the path for forms of a user portal
      Parameters:
      userPortal - The user portal.
      Returns:
      The path for forms of a user portal

    • getUserPortalResourcePath

      public static String getUserPortalResourcePath(UserPortal portal)
      Returns the path for a user portal resource.
      Parameters:
      portal - The user portal.
      Returns:
      The path for the user portal resource.

    • getUserProfileFileResourcePath

      public static String getUserProfileFileResourcePath(UserProfileFile file)
      Returns the path for a user profile file resource.
      Parameters:
      file - The user profile file.
      Returns:
      The path for the user profile file resource.

    • getUserProfilesBaseResourcePath

      public static String getUserProfilesBaseResourcePath()
      Returns the base path for user profile resources.
      Returns:
      The base path for user profile resources.

    • getUserProfileBaseResourcePath

      public static String getUserProfileBaseResourcePath()
      Returns the path for a user profile resource.
      Returns:
      The path for the user profile resource.

    • getUserProfileImagePath

      public static String getUserProfileImagePath()
      Returns the path for a user profile image resource.
      Returns:
      The path for the user profile image resource.