Package de.xima.fc.workflow.event
Class UserInvocationEventDataBuilder
- java.lang.Object
-
- de.xima.fc.workflow.event.ASpecificTriggerWithFormRecordEventDataBuilder<IFcUserInvocationEvent,UserInvocationEventDataBuilder>
-
- de.xima.fc.workflow.event.UserInvocationEventDataBuilder
-
- All Implemented Interfaces:
org.apache.commons.lang3.builder.Builder<IFcUserInvocationEvent>
public final class UserInvocationEventDataBuilder extends ASpecificTriggerWithFormRecordEventDataBuilder<IFcUserInvocationEvent,UserInvocationEventDataBuilder>
Builder for the event data for running a specific trigger, specified by its ID. This is used, for example, by timed or manual triggers.- Since:
- 8.2.0
- Author:
- XIMA MEDIA GmbH
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.xima.fc.workflow.event.ASpecificTriggerWithFormRecordEventDataBuilder
ASpecificTriggerWithFormRecordEventDataBuilder.ASpecificData
-
-
Field Summary
Fields Modifier and Type Field Description protected Boolean
anonymize
protected Clock
clock
protected Vorgang
formRecord
protected IFormRecordLockContext
formRecordLockContext
protected Locale
locale
protected IUser
user
protected List<IWorkflowExecutionPostProcessor>
workflowExecutionPostProcessors
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TThis
addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor workflowExecutionPostProcessor)
TThis
anonymize(Boolean anonymize)
IFcUserInvocationEvent
build()
TThis
clock(Clock clock)
TThis
formRecordLockContext(IFormRecordLockContext formRecordLockContext)
protected UserInvocationEventDataBuilder
getThis()
TThis
locale(Locale locale)
UserInvocationEventDataBuilder
skipUserGroupRestriction(boolean skipUserGroupRestriction)
Whether to skip the user group restriction.UserInvocationEventDataBuilder
skipWorkflowStateRestriction(boolean skipWorkflowStateRestriction)
Whether to skip the workflow state restriction.TThis
user(Benutzer user)
Deprecated.Useuser(IUser)
instead.TThis
user(IUser user)
TThis
workflowExecutionPostProcessors(Iterable<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors)
-
Methods inherited from class de.xima.fc.workflow.event.ASpecificTriggerWithFormRecordEventDataBuilder
client, project
-
-
-
-
Field Detail
-
anonymize
protected Boolean anonymize
-
clock
protected Clock clock
-
formRecord
protected final Vorgang formRecord
-
formRecordLockContext
protected IFormRecordLockContext formRecordLockContext
-
locale
protected Locale locale
-
user
protected IUser user
-
workflowExecutionPostProcessors
protected List<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors
-
-
Method Detail
-
build
public IFcUserInvocationEvent build()
-
skipUserGroupRestriction
public UserInvocationEventDataBuilder skipUserGroupRestriction(boolean skipUserGroupRestriction)
Whether to skip the user group restriction. When set to true, the trigger will be executed regardless of the user group of the user who triggered the event.- Parameters:
skipUserGroupRestriction
- Whether to skip the user group restriction.- Returns:
- This builder for chaining method calls.
-
skipWorkflowStateRestriction
public UserInvocationEventDataBuilder skipWorkflowStateRestriction(boolean skipWorkflowStateRestriction)
Whether to skip the workflow state restriction. When set to true, the trigger will be executed regardless of the workflow state of the form record.- Parameters:
skipWorkflowStateRestriction
- Whether to skip the workflow state restriction.- Returns:
- This builder for chaining method calls.
-
getThis
protected UserInvocationEventDataBuilder getThis()
-
addWorkflowExecutionPostProcessor
public TThis addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor workflowExecutionPostProcessor)
-
anonymize
public TThis anonymize(Boolean anonymize)
-
clock
public TThis clock(Clock clock)
-
formRecordLockContext
public TThis formRecordLockContext(IFormRecordLockContext formRecordLockContext)
-
locale
public TThis locale(Locale locale)
-
user
public TThis user(IUser user)
-
workflowExecutionPostProcessors
public TThis workflowExecutionPostProcessors(Iterable<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors)
-
user
@Deprecated public TThis user(Benutzer user)
Deprecated.Useuser(IUser)
instead.- Parameters:
user
- The user who started the workflow.- Returns:
- This builder instance for chaining method calls.
-
-