Package de.xima.fc.workflow

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowStateModel.Builder<T>	Builder for configuring a WorkflowStateModel from a state entity.

Field Summary

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
WorkflowStateModel()	Creates a new empty workflow state model.

Method Summary

Modifier and Type	Method	Description
static WorkflowStateModel.Builder<Status>	builder(Status state)	Deprecated.
static WorkflowStateModel.Builder<WorkflowState>	builder(WorkflowState state)	Creates a new builder for a WorkflowStateModel.
static Comparator<BaseConfigViewModel>	createAuthenticatorConfigsComparator(List<BaseConfigViewModel> configs)
AnonymousConfigViewModel	getAnonymousAuthenticator()
List<BaseConfigViewModel>	getAuthenticators()
String	getDescription()
String	getDescription(Locale locale)	Deprecated. use getDescription()
Long	getId()
String	getName()
String	getName(Locale locale)	Deprecated. use getName()
List<BaseConfigViewModel>	getNonOrderableAuthenticators()
List<BaseConfigViewModel>	getOrderableAuthenticators()
PasswordConfigViewModel	getPasswordAuthenticator()
List<BaseConfigViewModel>	getSelectedOrderableAuthenticators()
EWorkflowStateType	getType()
List<UuidEntityRef>	getUserGroups()
UserPortalStateConfigViewModel	getUserPortalConfig()	Gets the view model for the user portal configuration of this state.
UUID	getUuid()
boolean	isAllowAccessToAnonymousApplicant()
boolean	isAllowAccessToApplicant()
boolean	isAllowAuthenticatedUser()
boolean	isAllowPasswordAuthenticator()
@javax.validation.constraints.AssertTrue(message="{workflow.validaton.change.state.empty.authenticator}") boolean	isAuthenticatorsValid()
boolean	isExternalAccessPermitted()
boolean	isFormRecordDeletable()
boolean	isShowAllowAccessToApplicant()
boolean	isShowAllowAuthenticatedUser()
boolean	isShowAnonymousAuthenticatorOption()
boolean	isShowFormRecordsUnprotectedHint()
boolean	isShowPasswordOption()
boolean	isShowUserGroupsOption()
void	setAllowAccessToAnonymousApplicant(boolean allowAccessToAnonymousApplicant)
void	setAllowAccessToApplicant(boolean allowAccessToApplicant)
void	setAllowAuthenticatedUser(boolean allowAuthenticatedUser)
void	setAllowPasswordAuthenticator(boolean allowPasswordAuthenticator)
void	setAnonymousAuthenticator(AnonymousConfigViewModel anonymousAuthenticator)
void	setAuthenticators(List<BaseConfigViewModel> authenticators)
void	setAuthenticatorsValid(boolean authenticatorsValid)	Deprecated.
void	setDescription(String description)
void	setExternalAccessPermitted(boolean externalAccessPermitted)
void	setFormRecordDeletable(boolean formRecordDeletable)
void	setId(Long id)
void	setName(String name)
void	setNonOrderableAuthenticators(List<BaseConfigViewModel> nonOrderableAuthenticators)
void	setOrderableAuthenticators(List<BaseConfigViewModel> orderableAuthenticators)
void	setPasswordAuthenticator(PasswordConfigViewModel passwordAuthenticator)
void	setPortalStateConfigFromPresetIfMissing(EPortalStatePreset preset)
void	setSelectedOrderableAuthenticators(List<BaseConfigViewModel> orderableAuthenticators)
void	setType(EWorkflowStateType type)
void	setUserGroups(List<UuidEntityRef> userGroups)
void	setUserPortalStateConfig(UserPortalStateConfigViewModel userPortalStateConfig)	Sets the view model for the user portal configuration of this state.
void	setUuid(UUID uuid)
String	toString()
WorkflowState	toWorkflowState(Function<UUID,BenutzerGruppe> findUserGroupByUuid, Function<UUID,ClientAuthenticator> findClientAuthenticatorByUuid, Function<UUID,SystemAuthenticator> findSystemAuthenticatorByUuid)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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 Detail

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)

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 UserPortalStateConfigViewModel getUserPortalConfig()

Gets the view model for the user portal configuration of this state.

Returns:

The portal state view model.

setUserPortalStateConfig

public void setUserPortalStateConfig(UserPortalStateConfigViewModel userPortalStateConfig)

Sets the view model for the user portal configuration of this state.

Parameters:

userPortalStateConfig - The portal state view model.

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)

setPortalStateConfigFromPresetIfMissing

public void setPortalStateConfigFromPresetIfMissing(EPortalStatePreset preset)

isAuthenticatorsValid

@AssertTrue(message="{workflow.validaton.change.state.empty.authenticator}")
public @javax.validation.constraints.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.