Class FcUserInvocationProps

java.lang.Object

de.xima.fc.workflow.taglib.model.BaseTriggerProps

de.xima.fc.workflow.model.triggers.FcUserInvocationProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, Serializable

public final class FcUserInvocationProps
extends BaseTriggerProps

The properties model for workflow triggers of type EWorkflowTriggerType.FC_USER_INVOCATION.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEARCH_TERM_STATE_UUID	Key for storing the selected state UUIDs as WorkflowTriggerSearchTerms
static final String	SEARCH_TERM_USER_GROUP_UUID	Key for storing the selected user group UUIDs as WorkflowTriggerSearchTerms

Fields inherited from interface IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

Fields inherited from interface INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
FcUserInvocationProps()

Method Summary

Modifier and Type	Method	Description
EUserInvocationAccessType	getAccessType()
List<UuidEntityRef>	getAllowedUserGroups()
List<UuidEntityRef>	getAllowedWorkflowStates()
List<FcUserInvocationLocalizationEntry>	getLocalizations()	Localized messages for the trigger for each locale.
FcUserInvocationLocalizationEntry	getLocalizationsByLocale(Locale locale)
void	setAccessType(EUserInvocationAccessType accessType)
void	setAllowedUserGroups(List<UuidEntityRef> allowedUserGroups)
void	setAllowedWorkflowStates(List<UuidEntityRef> allowedWorkflowStates)
void	setLocalizations(List<FcUserInvocationLocalizationEntry> localizations)	Localized messages for the trigger for each locale.

Methods inherited from class BaseTriggerProps

getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName

Methods inherited from class Object

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

Field Details

SEARCH_TERM_STATE_UUID

public static final String SEARCH_TERM_STATE_UUID

Key for storing the selected state UUIDs as WorkflowTriggerSearchTerms

SEARCH_TERM_USER_GROUP_UUID

public static final String SEARCH_TERM_USER_GROUP_UUID

Key for storing the selected user group UUIDs as WorkflowTriggerSearchTerms

Constructor Details

FcUserInvocationProps

public FcUserInvocationProps()

Method Details

getAccessType

public EUserInvocationAccessType getAccessType()

Returns:

The access type of the trigger.

setAccessType

public void setAccessType(EUserInvocationAccessType accessType)

getAllowedUserGroups

public List<UuidEntityRef> getAllowedUserGroups()

Returns:

A list of all user groups a user must belong to in order for the trigger to react. When this list is empty, no restriction is applied.

setAllowedUserGroups

public void setAllowedUserGroups(List<UuidEntityRef> allowedUserGroups)

Parameters:

allowedUserGroups - A list of all user groups a user must belong to in order for the trigger to react. When this list is empty, no restriction is applied.

getAllowedWorkflowStates

public List<UuidEntityRef> getAllowedWorkflowStates()

Returns:

A list of all workflow states a form record must have in order for the trigger to react. When this list is empty, no restriction is applied.

setAllowedWorkflowStates

public void setAllowedWorkflowStates(List<UuidEntityRef> allowedWorkflowStates)

Parameters:

allowedWorkflowStates - A list of all workflow states a form record must have in order for the trigger to react. When this list is empty, no restriction is applied.

getLocalizations

public List<FcUserInvocationLocalizationEntry> getLocalizations()

Localized messages for the trigger for each locale.

Returns:

The localized messages of the trigger in different languages.

setLocalizations

public void setLocalizations(List<FcUserInvocationLocalizationEntry> localizations)

Localized messages for the trigger for each locale.

Parameters:

localizations - The localized messages of the trigger in different languages.

getLocalizationsByLocale

public FcUserInvocationLocalizationEntry getLocalizationsByLocale(Locale locale)