Package de.xima.fc.entities

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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ACCESS_USER_GROUPS	JPA attribute name for the getAccessUserGroups() field.
static String	ATTR_AUTHENTICATOR_CONFIGS	JPA attribute name for the getAuthenticatorConfigs() field.
static String	ATTR_EXTERNAL_ACCESS_PERMITTED	JPA attribute name for the isExternalAccessPermitted() field.
static String	ATTR_FORM_RECORD_DELETABLE	JPA attribute name for the isFormRecordDeletable() field.
static String	ATTR_ORDER_INDEX	JPA attribute name for the getOrderIndex() field.
static String	ATTR_TYPE	JPA attribute name for the getType() field.
static String	ATTR_USE_SYSTEM_AUTHENTICATION	Deprecated. Use ATTR_EXTERNAL_ACCESS_PERMITTED instead
static String	ATTR_VERSION	JPA attribute name for the getVersion() field.
static String	COL_EXTERNAL_ACCESS_PERMITTED	Database column name for the isUseSystemAuthentication() field.
static String	COL_FORM_RECORD_DELETABLE	Database column name for the isFormRecordDeletable() field.
static String	COL_NAME	Database column name for the getName() field.
static String	COL_ORDER_INDEX	Database column name for the getOrderIndex() field.
static String	COL_TYPE	Database column name for the getType() field.
static String	COL_USE_SYSTEM_AUTHENTICATION	Deprecated. Use COL_EXTERNAL_ACCESS_PERMITTED instead
static String	COL_VERSION	Database column name for the getVersion() field.

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

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

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

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

ATTR_NAME

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

IMPORT_ID, INVALID_ID

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

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
WorkflowState()

Method Summary

Modifier and Type	Method	Description
WorkflowState	cloneBasics()
List<BenutzerGruppe>	getAccessUserGroups()
List<WorkflowStateAuthenticatorConfig>	getAuthenticatorConfigs()
String	getBeschreibung()	Deprecated.
String	getDescription()
String	getDescription(Locale locale)
Long	getId()
String	getName()
String	getName(Locale locale)
int	getOrderIndex()
EWorkflowStateType	getType()
UUID	getUuid()
String	getUUID()
UUID	getUUIDObject()
WorkflowVersion	getVersion()
boolean	isExternalAccessPermitted()
boolean	isFormRecordDeletable()
boolean	isUseSystemAuthentication()	Deprecated. Use isExternalAccessPermitted() instead
void	setAccessUserGroups(List<BenutzerGruppe> userGroups)
void	setAuthenticatorConfigs(List<WorkflowStateAuthenticatorConfig> authenticatorConfigs)
void	setDescription(String description)
void	setExternalAccessPermitted(boolean externalAccessPermitted)
void	setFormRecordDeletable(boolean formRecordDeletable)
void	setName(String name)
void	setOrderIndex(int orderIndex)
void	setType(EWorkflowStateType type)
void	setUseSystemAuthentication(boolean useSystemAuthentication)	Deprecated. Use setExternalAccessPermitted(boolean) instead
void	setUUID(String uuid)
void	setUUIDObject(UUID uuid)
void	setVersion(WorkflowVersion version)
String	toString()

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted, setId

Field Detail

ATTR_EXTERNAL_ACCESS_PERMITTED

public static final String ATTR_EXTERNAL_ACCESS_PERMITTED

JPA attribute name for the isExternalAccessPermitted() field.

See Also:

Constant Field Values

ATTR_AUTHENTICATOR_CONFIGS

public static final String ATTR_AUTHENTICATOR_CONFIGS

JPA attribute name for the getAuthenticatorConfigs() field.

See Also:

Constant Field Values

ATTR_ACCESS_USER_GROUPS

public static final String ATTR_ACCESS_USER_GROUPS

JPA attribute name for the getAccessUserGroups() field.

See Also:

Constant Field Values

ATTR_FORM_RECORD_DELETABLE

public static final String ATTR_FORM_RECORD_DELETABLE

JPA attribute name for the isFormRecordDeletable() field.

See Also:

Constant Field Values

ATTR_ORDER_INDEX

public static final String ATTR_ORDER_INDEX

JPA attribute name for the getOrderIndex() field.

See Also:

Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

JPA attribute name for the getType() field.

See Also:

Constant Field Values

ATTR_VERSION

public static final String ATTR_VERSION

JPA attribute name for the getVersion() field.

See Also:

Constant Field Values

ATTR_USE_SYSTEM_AUTHENTICATION

@Deprecated
public static final String ATTR_USE_SYSTEM_AUTHENTICATION

Deprecated.

Use ATTR_EXTERNAL_ACCESS_PERMITTED instead

See Also:

Constant Field Values

COL_EXTERNAL_ACCESS_PERMITTED

public static final String COL_EXTERNAL_ACCESS_PERMITTED

Database column name for the isUseSystemAuthentication() field.

See Also:

Constant Field Values

COL_FORM_RECORD_DELETABLE

public static final String COL_FORM_RECORD_DELETABLE

Database column name for the isFormRecordDeletable() field.

See Also:

Constant Field Values

COL_NAME

public static final String COL_NAME

Database column name for the getName() field.

See Also:

Constant Field Values

COL_ORDER_INDEX

public static final String COL_ORDER_INDEX

Database column name for the getOrderIndex() field.

See Also:

Constant Field Values

COL_TYPE

public static final String COL_TYPE

Database column name for the getType() field.

See Also:

Constant Field Values

COL_VERSION

public static final String COL_VERSION

Database column name for the getVersion() field.

See Also:

Constant Field Values

COL_USE_SYSTEM_AUTHENTICATION

@Deprecated
public static final String COL_USE_SYSTEM_AUTHENTICATION

Deprecated.

Use COL_EXTERNAL_ACCESS_PERMITTED instead

See Also:

Constant Field Values

Constructor Detail

WorkflowState

public WorkflowState()

Method Detail

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 or not 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

getAuthenticatorConfigs

public List<WorkflowStateAuthenticatorConfig> getAuthenticatorConfigs()

Returns:

custom authenticator configuration of this workflow state

getAccessUserGroups

public List<BenutzerGruppe> getAccessUserGroups()

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.

getDescription

public String getDescription(Locale locale)

Parameters:

locale - Locale for which to get the description.

Returns:

The description of this state. This is the getDescription() when getType() is set to EWorkflowStateType.CUSTOM, or EWorkflowStateType.getDisplayDescription(Locale) otherwise.

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.

getName

public String getName(Locale locale)

Parameters:

locale - Locale for which to get the name.

Returns:

The name of this state. This is the getName() when getType() is set to EWorkflowStateType.CUSTOM, or EWorkflowStateType.getDisplayName(Locale) otherwise.

getOrderIndex

public int getOrderIndex()

Returns:

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.

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

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.

getUUIDObject

public UUID getUUIDObject()

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.

getVersion

public WorkflowVersion getVersion()

Returns:

The version to which this workflow state belongs, see WorkflowVersion.getStates().

isFormRecordDeletable

public boolean isFormRecordDeletable()

Returns:

Whether a form record in this state can be deleted manually by a user in the inbox.

setAuthenticatorConfigs

public void setAuthenticatorConfigs(List<WorkflowStateAuthenticatorConfig> authenticatorConfigs)

Parameters:

authenticatorConfigs - custom authenticator configuration of this workflow state

setAccessUserGroups

public void setAccessUserGroups(List<BenutzerGruppe> userGroups)

setDescription

public void setDescription(String description)

Parameters:

description - The description of this item, as entered by the user.

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.

setName

public void setName(String name)

Parameters:

name - The name of this item, as entered by the user.

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.

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.

setUUID

public void setUUID(String uuid)

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.

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.

setVersion

public void setVersion(WorkflowVersion version)

Parameters:

version - The version to which this workflow state belongs.

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