Package de.xima.fc.entities

Class WorkflowStateAuthenticatorConfig

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.ALockableEntity

de.xima.fc.entities.AAuthenticatorConfig

de.xima.fc.entities.WorkflowStateAuthenticatorConfig

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IAuthenticatorConfig, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IStringAttributesMixin, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class WorkflowStateAuthenticatorConfig
extends AAuthenticatorConfig

Model for persisting authenticator configuration of a WorkflowState

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_ATTRIBUTES	JPA attribute name for the getAttributes() field.
static final String	ATTR_ORDER_INDEX	JPA attribute name for the getOrderIndex() field.
static final String	ATTR_WORKFLOW_STATE	JPA attribute name for the getWorkflowState() field.
static final String	COL_ORDER_INDEX	Database column name for the getOrderIndex() field.
static final String	COL_WORKFLOW_STATE_ID	Database column name for the getWorkflowState() field.

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

ATTR_AUTHENTICATOR_TYPE, ATTR_CLIENTAUTHENTICATOR, ATTR_ORDER_IDX, ATTR_SYSTEMAUTHENTICATOR, authenticatorType, clientAuthenticator, systemAuthenticator

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.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.ITransferableEntity

IMPORT_ID, INVALID_ID

Constructor Summary

Constructors

Constructor	Description
WorkflowStateAuthenticatorConfig()
WorkflowStateAuthenticatorConfig(WorkflowState workflowState, IAuthenticator<?> authenticator, Map<String,String> attributes)
WorkflowStateAuthenticatorConfig(WorkflowState workflowState, EAuthClientType authenticatorType)
WorkflowStateAuthenticatorConfig(WorkflowState workflowState, EAuthClientType authenticatorType, Map<String,String> attributes)

Method Summary

Modifier and Type	Method	Description
WorkflowStateAuthenticatorConfig	cloneBasics()
Map<String,String>	getAttributes()
Long	getId()
int	getOrderIndex()
WorkflowState	getWorkflowState()
void	setAttributes(Map<String,String> attributes)
void	setOrderIndex(Integer orderIndex)
void	setWorkflowState(WorkflowState workflowState)

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

getAuthenticator, getAuthenticatorToken, getAuthenticatorType, getClientAuthenticator, getClientDescriptor, getDisplayName, getI18nPlaceholder, getIdentifier, getSystemAuthenticator, setAuthenticator, setAuthenticatorType, setClientAuthenticator, setSystemAuthenticator, 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

Methods inherited from interface de.xima.fc.interfaces.mixin.attributes.IStringAttributesMixin

getAttributeValue, getAttributeValueList, getAttributeValueMap, putAttribute, putAttributes, putAttributes, removeAttribute

Field Details

ATTR_ATTRIBUTES

public static final String ATTR_ATTRIBUTES

JPA attribute name for the getAttributes() 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_WORKFLOW_STATE

public static final String ATTR_WORKFLOW_STATE

JPA attribute name for the getWorkflowState() 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_WORKFLOW_STATE_ID

public static final String COL_WORKFLOW_STATE_ID

Database column name for the getWorkflowState() field.

See Also:

• Constant Field Values

Constructor Details

WorkflowStateAuthenticatorConfig

public WorkflowStateAuthenticatorConfig()

WorkflowStateAuthenticatorConfig

public WorkflowStateAuthenticatorConfig(WorkflowState workflowState,
 EAuthClientType authenticatorType)

WorkflowStateAuthenticatorConfig

public WorkflowStateAuthenticatorConfig(WorkflowState workflowState,
 EAuthClientType authenticatorType,
 Map<String,String> attributes)

WorkflowStateAuthenticatorConfig

public WorkflowStateAuthenticatorConfig(WorkflowState workflowState,
 IAuthenticator<?> authenticator,
 Map<String,String> attributes)

Method Details

getId

public Long getId()

getWorkflowState

public WorkflowState getWorkflowState()

Returns:

The workflow state for which this authenticator was configured.

setWorkflowState

public void setWorkflowState(WorkflowState workflowState)

Parameters:

workflowState - The workflow state for which this authenticator was configured.

getAttributes

public Map<String,String> getAttributes()

Returns:

the string attributes

setAttributes

public void setAttributes(Map<String,String> attributes)

Parameters:

attributes - Custom attributes for this authenticator. The available properties depend on the authenticator type.

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

Parameters:

orderIndex - The 0-based position where this state appears on the UI for managing the states of a workflow version.

cloneBasics

public WorkflowStateAuthenticatorConfig cloneBasics()

Returns:

A new workflow state authenticator config instance with all fields that do not reference other entites copied from this instance.