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

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	forState(Status state, Locale locale)
static WorkflowStateModel	forWorkflowState(WorkflowState workflowState, Locale locale)
AnonymousConfigViewModel	getAnonymousAuthenticator()
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()
EWorkflowStateType	getType()
List<UuidEntityRef>	getUserGroups()
UUID	getUuid()
boolean	isExternalAccessPermitted()
boolean	isFormRecordDeletable()
boolean	isShowAnonymousAuthenticatorOption()
boolean	isShowFormRecordsUnprotectedHint()
boolean	isShowUserGroupsOption()
void	setAnonymousAuthenticator(AnonymousConfigViewModel anonymousAuthenticator)
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	setType(EWorkflowStateType type)
void	setUserGroups(List<UuidEntityRef> userGroups)
void	setUuid(UUID uuid)
String	toString()
WorkflowState	toWorkflowState(Function<UUID,BenutzerGruppe> userGroupDao, Function<UUID,ClientAuthenticator> clientAuthDao, Function<UUID,SystemAuthenticator> systemAuthDao)

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 forWorkflowState(WorkflowState, Locale) when possible to fill with the data of a given state.

Method Detail

getAnonymousAuthenticator

public AnonymousConfigViewModel getAnonymousAuthenticator()

getDescription

public String getDescription()

getDescription

@Deprecated
public String getDescription(Locale locale)

Deprecated.

use getDescription()

getId

public Long getId()

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this object.

getName

@Deprecated
public String getName(Locale locale)

Deprecated.

use getName()

getNonOrderableAuthenticators

public List<BaseConfigViewModel> getNonOrderableAuthenticators()

getOrderableAuthenticators

public List<BaseConfigViewModel> getOrderableAuthenticators()

getPasswordAuthenticator

public PasswordConfigViewModel getPasswordAuthenticator()

getType

public EWorkflowStateType getType()

getUserGroups

public List<UuidEntityRef> getUserGroups()

getUuid

public UUID getUuid()

Specified by:

getUuid in interface IUuidProviding

Returns:

The UUID that identifies this instance.

isExternalAccessPermitted

public boolean isExternalAccessPermitted()

isFormRecordDeletable

public boolean isFormRecordDeletable()

isShowAnonymousAuthenticatorOption

public boolean isShowAnonymousAuthenticatorOption()

isShowFormRecordsUnprotectedHint

public boolean isShowFormRecordsUnprotectedHint()

isShowUserGroupsOption

public boolean isShowUserGroupsOption()

setAnonymousAuthenticator

public void setAnonymousAuthenticator(AnonymousConfigViewModel anonymousAuthenticator)

setDescription

public void setDescription(String description)

setExternalAccessPermitted

public void setExternalAccessPermitted(boolean externalAccessPermitted)

setFormRecordDeletable

public void setFormRecordDeletable(boolean formRecordDeletable)

setId

public void setId(Long id)

setName

public void setName(String name)

setNonOrderableAuthenticators

public void setNonOrderableAuthenticators(List<BaseConfigViewModel> nonOrderableAuthenticators)

setOrderableAuthenticators

public void setOrderableAuthenticators(List<BaseConfigViewModel> orderableAuthenticators)

setPasswordAuthenticator

public void setPasswordAuthenticator(PasswordConfigViewModel passwordAuthenticator)

setType

public void setType(EWorkflowStateType type)

setUserGroups

public void setUserGroups(List<UuidEntityRef> userGroups)

setUuid

public void setUuid(UUID uuid)

toString

public String toString()

Overrides:

toString in class Object

toWorkflowState

public WorkflowState toWorkflowState(Function<UUID,BenutzerGruppe> userGroupDao,
                                     Function<UUID,ClientAuthenticator> clientAuthDao,
                                     Function<UUID,SystemAuthenticator> systemAuthDao)

forWorkflowState

public static WorkflowStateModel forWorkflowState(WorkflowState workflowState,
                                                  Locale locale)

forState

public static WorkflowStateModel forState(Status state,
                                          Locale locale)