Package de.xima.fc.workflow.processor.factory

Interface IUserInvocationTriggerBuilder

public interface IUserInvocationTriggerBuilder

A builder for a new event of type EWorkflowTriggerType.FC_USER_INVOCATION that occurs when a portal user initiates it.

Since:

8.2.0

Method Summary

Modifier and Type	Method	Description
WorkflowTrigger	build()	Builds a new WorkflowTrigger instance of type FC_USER_INVOCATION with the current configuration.
FcUserInvocationProps	buildProps()	Builds a new user invocation trigger model instance with the current configuration.
IUserInvocationTriggerBuilder	displayName(Locale locale, String displayName)	Sets the display name of the trigger in a specific locale.
IUserInvocationTriggerBuilder	userGroup(BenutzerGruppe userGroup)	Adds a user group to the list of groups that is allowed to initiate the trigger.
default IUserInvocationTriggerBuilder	userGroups(BenutzerGruppe... userGroups)	Adds user groups to the list of groups that is allowed to initiate the trigger.
default IUserInvocationTriggerBuilder	userGroups(Iterable<BenutzerGruppe> userGroups)	Adds user groups to the list of groups that is allowed to initiate the trigger.
IUserInvocationTriggerBuilder	workflowState(WorkflowState state)	Adds a workflow state to the list of state a form record must have for the trigger to be initiated.
default IUserInvocationTriggerBuilder	workflowStates(WorkflowState... states)	Adds workflow states to the list of state a form record must have for the trigger to be initiated.
default IUserInvocationTriggerBuilder	workflowStates(Iterable<WorkflowState> states)	Adds workflow states to the list of state a form record must have for the trigger to be initiated.

Method Detail

build

WorkflowTrigger build()
               throws FastJsonException

Builds a new WorkflowTrigger instance of type FC_USER_INVOCATION with the current configuration.

Returns:

The new WorkflowTrigger instance.

Throws:

FastJsonException - When the model could not be serialized.

buildProps

FcUserInvocationProps buildProps()

Builds a new user invocation trigger model instance with the current configuration.

Returns:

The new model.

displayName

IUserInvocationTriggerBuilder displayName(Locale locale,
                                          String displayName)

Sets the display name of the trigger in a specific locale.

Parameters:

locale - The locale.

displayName - The display name.

Returns:

This builder for chaining method calls.

userGroup

IUserInvocationTriggerBuilder userGroup(BenutzerGruppe userGroup)

Adds a user group to the list of groups that is allowed to initiate the trigger. When no group is set, no restriction is applied.

Parameters:

userGroup - A user group to add.

Returns:

This builder for chaining method calls.

userGroups

default IUserInvocationTriggerBuilder userGroups(BenutzerGruppe... userGroups)

Adds user groups to the list of groups that is allowed to initiate the trigger. When no group is set, no restriction is applied.

Parameters:

userGroups - User groups to add.

Returns:

This builder for chaining method calls.

userGroups

default IUserInvocationTriggerBuilder userGroups(Iterable<BenutzerGruppe> userGroups)

Adds user groups to the list of groups that is allowed to initiate the trigger. When no group is set, no restriction is applied.

Parameters:

userGroups - User groups to add.

Returns:

This builder for chaining method calls.

workflowState

IUserInvocationTriggerBuilder workflowState(WorkflowState state)

Adds a workflow state to the list of state a form record must have for the trigger to be initiated. When no state is set, no restriction is applied.

Parameters:

state - A workflow state to add.

Returns:

This builder for chaining method calls.

workflowStates

default IUserInvocationTriggerBuilder workflowStates(WorkflowState... states)

Adds workflow states to the list of state a form record must have for the trigger to be initiated. When no state is set, no restriction is applied.

Parameters:

states - Workflow states to add.

Returns:

This builder for chaining method calls.

workflowStates

default IUserInvocationTriggerBuilder workflowStates(Iterable<WorkflowState> states)

Adds workflow states to the list of state a form record must have for the trigger to be initiated. When no state is set, no restriction is applied.

Parameters:

states - Workflow states to add.

Returns:

This builder for chaining method calls.