Class WorkflowState

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.WorkflowState
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, ILockingVersionProviding, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, IUuidProviding, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class WorkflowState extends AbstractLockableEntity implements IUUIDEntity, IUuidProviding, INameProviding, IDescriptionProviding
Describes the state of a Vorgang. A form record can only have one state at a time, such as archived or in_progress. This is the closest analog of the Status from the old workflow. The state can be used, for example, to restrict which users or user groups can access the form, or which form elements should be available.
Since:
7.0.0
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

  • Constructor Details

    • WorkflowState

      public WorkflowState()

  • Method Details

    • cloneBasics

      public WorkflowState cloneBasics()
      Returns:
      A new state instance with all fields that do not reference other entities copied from this instance.

    • isExternalAccessPermitted

      public boolean isExternalAccessPermitted()
      Returns:
      Whether it is allowed to access form records in this state. If true then getAuthenticatorConfigs() determines the available authentication methods

    • setExternalAccessPermitted

      public void setExternalAccessPermitted(boolean externalAccessPermitted)
      Parameters:
      externalAccessPermitted - Whether or not it is allowed to access form records in this state

    • isAllowAccessAllParticipants

      public boolean isAllowAccessAllParticipants()
      Returns:
      Whether all participants of a form record in this state are allowed to access the form record.

    • setAllowAccessAllParticipants

      public void setAllowAccessAllParticipants(boolean allowAccessAllParticipants)
      Parameters:
      allowAccessAllParticipants - Whether all participants of a form record in this state are allowed to access the form record.

    • isAllowAccessToApplicant

      public boolean isAllowAccessToApplicant()
      Returns:
      Whether or not the applicant is allowed to access a form record in this state.

    • setAllowAccessToApplicant

      public void setAllowAccessToApplicant(boolean allowAccessToApplicant)
      Parameters:
      allowAccessToApplicant - Whether or not the applicant is allowed to access a form record in this state.

    • isAllowAccessToAnonymousApplicant

      public boolean isAllowAccessToAnonymousApplicant()
      Returns:
      Whether or not anonymous applicants are allowed to access form records in this state.

    • setAllowAccessToAnonymousApplicant

      public void setAllowAccessToAnonymousApplicant(boolean allowAccessToAnonymousApplicant)
      Parameters:
      allowAccessToAnonymousApplicant - Whether or not anonymous applicants are allowed to access form records in this state.

    • addAuthenticatorConfig

      public void addAuthenticatorConfig(WorkflowStateAuthenticatorConfig authenticatorConfig)

    • getAuthenticatorConfigs

      public List<WorkflowStateAuthenticatorConfig> getAuthenticatorConfigs()
      Returns:
      custom authenticator configuration of this workflow state

    • setAuthenticatorConfigs

      public void setAuthenticatorConfigs(List<WorkflowStateAuthenticatorConfig> authenticatorConfigs)
      Parameters:
      authenticatorConfigs - custom authenticator configuration of this workflow state

    • getAccessUserGroups

      public List<BenutzerGruppe> getAccessUserGroups()

    • setAccessUserGroups

      public void setAccessUserGroups(List<BenutzerGruppe> userGroups)

    • getBeschreibung

      @Deprecated public String getBeschreibung()
      Deprecated.
      Specified by:
      getBeschreibung in interface IDescriptionProviding

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface IDescriptionProviding
      Returns:
      A human-readable description for this object.

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - The description of this item, as entered by the user.

    • getDescription

      @Deprecated public String getDescription(Locale locale)
      Deprecated.
      use getDescription()
      Parameters:
      locale - Locale for which to get the description.
      Returns:
      The description of this state.

    • getId

      public Long getId()
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

    • getName

      public String getName()
      Specified by:
      getName in interface INameProviding
      Returns:
      The name of this object.

    • setName

      public void setName(String name)
      Parameters:
      name - The name of this item, as entered by the user.

    • getName

      @Deprecated public String getName(Locale locale)
      Deprecated.
      use getName()
      Parameters:
      locale - Locale for which to get the name.
      Returns:
      The name of this state.

    • getOrderIndex

      public int getOrderIndex()
      Returns:
      The 0-based position where this state appears on the UI for managing the states of a workflow version.

    • setOrderIndex

      public void setOrderIndex(int orderIndex)
      Parameters:
      orderIndex - The 0-based position where this state appears on the UI for managing the states of a workflow version.

    • getType

      public EWorkflowStateType getType()
      Returns:
      The type of this state, whether it is a special system state, or a custom state defined by the user.

    • setType

      public void setType(EWorkflowStateType type)
      Parameters:
      type - The type of this state, whether it is a special system state, or a custom state defined by the user.

    • getUuid

      public UUID getUuid()
      Specified by:
      getUuid in interface IUuidProviding
      Returns:
      The UUID of this workflow state that identifies it. Please note that this UUID is unique only within the WorkflowVersion.getStates() of a certain workflow version. Two states of different workflow version may share the same UUID.

    • getUUID

      public String getUUID()
      Description copied from interface: IUUIDEntity
      Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      getUUID in interface IUUIDEntity
      Returns:
      The UUID of this workflow state that identifies it. Please note that this UUID is unique only within the WorkflowVersion.getStates() of a certain workflow version. Two states of different workflow version may share the same UUID.

    • setUUID

      public void setUUID(String uuid)
      Description copied from interface: IUUIDEntity
      Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      setUUID in interface IUUIDEntity
      Parameters:
      uuid - The UUID of this workflow state that identifies it. Please note that this UUID is unique only within the WorkflowVersion.getStates() of a certain workflow version. Two states of different workflow version may share the same UUID.

    • getUUIDObject

      public UUID getUUIDObject()
      Description copied from interface: IUUIDEntity
      Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.
      Specified by:
      getUUIDObject in interface IUUIDEntity
      Returns:
      The UUID of this workflow state that identifies it. Please note that this UUID is unique only within the WorkflowVersion.getStates() of a certain workflow version. Two states of different workflow version may share the same UUID.

    • setUUIDObject

      public void setUUIDObject(UUID uuid)
      Parameters:
      uuid - The UUID of this workflow state that identifies it. Please note that this UUID is unique only within the WorkflowVersion.getStates() of a certain workflow version. Two states of different workflow version may share the same UUID.

    • getVersion

      public WorkflowVersion getVersion()
      Returns:
      The version to which this workflow state belongs, see WorkflowVersion.getStates().

    • setVersion

      public void setVersion(WorkflowVersion version)
      Parameters:
      version - The version to which this workflow state belongs.

    • getEndUserState

      public EndUserState getEndUserState()

    • setEndUserState

      public void setEndUserState(EndUserState endUserState)

    • isFormRecordDeletable

      public boolean isFormRecordDeletable()
      Returns:
      Whether a form record in this state can be deleted manually by a user in the inbox.

    • setFormRecordDeletable

      public void setFormRecordDeletable(boolean formRecordDeletable)
      Parameters:
      formRecordDeletable - Whether a form record in this state can be deleted manually by a user in the inbox.

    • toString

      public String toString()
      Overrides:
      toString in class AbstractLockableEntity

    • isUseSystemAuthentication

      @Deprecated public boolean isUseSystemAuthentication()
      Deprecated.
      Use isExternalAccessPermitted() instead
      Returns:
      Whether to use the default system authentication or a custom authentication config when accessing the form records in this state

    • setUseSystemAuthentication

      @Deprecated public void setUseSystemAuthentication(boolean useSystemAuthentication)
      Deprecated.
      Use setExternalAccessPermitted(boolean) instead
      Parameters:
      useSystemAuthentication - sets whether to use the default system authentication or a custom authentication config when accessing the form records in this state

    • applyAuthOrderIndex

      public void applyAuthOrderIndex()