Class WorkflowStateModel

java.lang.Object
de.xima.fc.workflow.WorkflowStateModel
All Implemented Interfaces:
INameProviding, IUuidProviding, Serializable
public final class WorkflowStateModel extends Object implements Serializable, IUuidProviding, INameProviding
View model of a WorkflowState that can be sent to the client.
Since:
7.0.0
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Details

    • WorkflowStateModel

      public WorkflowStateModel()
      Creates a new empty workflow state model. Prefer builder(WorkflowState) when possible to fill with the data of a given state.

  • Method Details

    • createAuthenticatorConfigsComparator

      public static Comparator<BaseConfigViewModel> createAuthenticatorConfigsComparator(List<BaseConfigViewModel> configs)

    • getAnonymousAuthenticator

      public AnonymousConfigViewModel getAnonymousAuthenticator()

    • setAnonymousAuthenticator

      public void setAnonymousAuthenticator(AnonymousConfigViewModel anonymousAuthenticator)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getId

      public Long getId()

    • setId

      public void setId(Long id)

    • getName

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

    • setName

      public void setName(String name)

    • getNonOrderableAuthenticators

      public List<BaseConfigViewModel> getNonOrderableAuthenticators()

    • setNonOrderableAuthenticators

      public void setNonOrderableAuthenticators(List<BaseConfigViewModel> nonOrderableAuthenticators)

    • getOrderableAuthenticators

      public List<BaseConfigViewModel> getOrderableAuthenticators()

    • setOrderableAuthenticators

      public void setOrderableAuthenticators(List<BaseConfigViewModel> orderableAuthenticators)

    • getAuthenticators

      public List<BaseConfigViewModel> getAuthenticators()

    • setAuthenticators

      public void setAuthenticators(List<BaseConfigViewModel> authenticators)

    • isAllowPasswordAuthenticator

      public boolean isAllowPasswordAuthenticator()

    • setAllowPasswordAuthenticator

      public void setAllowPasswordAuthenticator(boolean allowPasswordAuthenticator)

    • isAllowPasswordGeneratorOption

      public boolean isAllowPasswordGeneratorOption()

    • setAllowPasswordGeneratorOption

      public void setAllowPasswordGeneratorOption(boolean allowPasswordGeneratorOption)

    • getGeneratedPasswordAuthenticator

      public GeneratedPasswordConfigViewModel getGeneratedPasswordAuthenticator()

    • setGeneratedPasswordAuthenticator

      public void setGeneratedPasswordAuthenticator(GeneratedPasswordConfigViewModel generatedPasswordAuthenticator)

    • getPasswordAuthenticator

      public PasswordConfigViewModel getPasswordAuthenticator()

    • setPasswordAuthenticator

      public void setPasswordAuthenticator(PasswordConfigViewModel passwordAuthenticator)

    • getType

      public EWorkflowStateType getType()

    • setType

      public void setType(EWorkflowStateType type)

    • getUserGroups

      public List<UuidEntityRef> getUserGroups()

    • setUserGroups

      public void setUserGroups(List<UuidEntityRef> userGroups)

    • getUserPortalConfig

      public EndUserStateConfigViewModel getUserPortalConfig()
      Gets the view model for the user portal configuration of this state.
      Returns:
      The end user state view model.

    • setEndUserStateConfig

      public void setEndUserStateConfig(EndUserStateConfigViewModel endUserStateConfig)
      Sets the view model for the user portal configuration of this state.
      Parameters:
      endUserStateConfig - The end user state view model.

    • isAllowAccessAllParticipants

      public boolean isAllowAccessAllParticipants()

    • setAllowAccessAllParticipants

      public void setAllowAccessAllParticipants(boolean allowAccessAllParticipants)

    • getUuid

      public UUID getUuid()
      Specified by:
      getUuid in interface IUuidProviding
      Returns:
      The UUID that identifies this instance.

    • setUuid

      public void setUuid(UUID uuid)

    • isExternalAccessPermitted

      public boolean isExternalAccessPermitted()

    • setExternalAccessPermitted

      public void setExternalAccessPermitted(boolean externalAccessPermitted)

    • isAllowAccessToApplicant

      public boolean isAllowAccessToApplicant()

    • setAllowAccessToApplicant

      public void setAllowAccessToApplicant(boolean allowAccessToApplicant)

    • isAllowAccessToAnonymousApplicant

      public boolean isAllowAccessToAnonymousApplicant()

    • setAllowAccessToAnonymousApplicant

      public void setAllowAccessToAnonymousApplicant(boolean allowAccessToAnonymousApplicant)

    • isAllowAuthenticatedUser

      public boolean isAllowAuthenticatedUser()

    • setAllowAuthenticatedUser

      public void setAllowAuthenticatedUser(boolean allowAuthenticatedUser)

    • isFormRecordDeletable

      public boolean isFormRecordDeletable()

    • setFormRecordDeletable

      public void setFormRecordDeletable(boolean formRecordDeletable)

    • isShowPasswordOption

      public boolean isShowPasswordOption()

    • isShowAllowAccessToApplicant

      public boolean isShowAllowAccessToApplicant()

    • isShowAllowAuthenticatedUser

      public boolean isShowAllowAuthenticatedUser()

    • isShowAnonymousAuthenticatorOption

      public boolean isShowAnonymousAuthenticatorOption()

    • isShowFormRecordsUnprotectedHint

      public boolean isShowFormRecordsUnprotectedHint()

    • isShowUserGroupsOption

      public boolean isShowUserGroupsOption()

    • getSelectedOrderableAuthenticators

      public List<BaseConfigViewModel> getSelectedOrderableAuthenticators()

    • setSelectedOrderableAuthenticators

      public void setSelectedOrderableAuthenticators(List<BaseConfigViewModel> orderableAuthenticators)

    • setEndUserStateConfigFromPresetIfMissing

      public void setEndUserStateConfigFromPresetIfMissing(EEndUserStatePreset preset, Locale clientLocale)

    • isAuthenticatorsValid

      @AssertTrue(message="{workflow.validaton.change.state.empty.authenticator}") public @AssertTrue(message="{workflow.validaton.change.state.empty.authenticator}") boolean isAuthenticatorsValid()

    • setAuthenticatorsValid

      @Deprecated public void setAuthenticatorsValid(boolean authenticatorsValid)
      Deprecated.

    • getDescription

      @Deprecated public String getDescription(Locale locale)
      Deprecated.
      use getDescription()

    • getName

      @Deprecated public String getName(Locale locale)
      Deprecated.
      use getName()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toWorkflowState

      public WorkflowState toWorkflowState(Function<UUID, BenutzerGruppe> findUserGroupByUuid, Function<UUID, ClientAuthenticator> findClientAuthenticatorByUuid, Function<UUID, SystemAuthenticator> findSystemAuthenticatorByUuid)

    • builder

      public static WorkflowStateModel.Builder<WorkflowState> builder(WorkflowState state)
      Creates a new builder for a WorkflowStateModel.
      Parameters:
      state - The state to create the model for.
      Returns:
      The new builder.

    • builder

      @Deprecated public static WorkflowStateModel.Builder<Status> builder(Status state)
      Deprecated.
      Creates a new builder for a WorkflowStateModel.
      Parameters:
      state - The state to create the model for.
      Returns:
      The new builder.