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 ASpecificTriggerWithFormRecordEventDataBuilder

ASpecificTriggerWithFormRecordEventDataBuilder.ASpecificData

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	anonymize
protected Clock	clock
protected final Vorgang	formRecord
protected IFormRecordLockContext	formRecordLockContext
protected Locale	locale
protected IUser	user
protected List<IWorkflowExecutionPostProcessor>	workflowExecutionPostProcessors

Method Summary

Modifier and Type	Method	Description
UserInvocationEventDataBuilder	addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor workflowExecutionPostProcessor)
UserInvocationEventDataBuilder	anonymize(Boolean anonymize)
IFcUserInvocationEvent	build()
UserInvocationEventDataBuilder	clock(Clock clock)
UserInvocationEventDataBuilder	formRecordLockContext(IFormRecordLockContext formRecordLockContext)
protected UserInvocationEventDataBuilder	getThis()
UserInvocationEventDataBuilder	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.
UserInvocationEventDataBuilder	trigger(WorkflowTrigger trigger)	Sets the trigger
UserInvocationEventDataBuilder	user(Benutzer user)	Deprecated.
UserInvocationEventDataBuilder	user(IUser user)
UserInvocationEventDataBuilder	workflowExecutionPostProcessors(Iterable<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors)

Methods inherited from class ASpecificTriggerWithFormRecordEventDataBuilder

client, project

Methods inherited from class Object

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

Field Details

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 Details

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.

trigger

public UserInvocationEventDataBuilder trigger(WorkflowTrigger trigger)

Sets the trigger

Parameters:

trigger - The trigger to set.

Returns:

This builder for chaining method calls.

getThis

protected UserInvocationEventDataBuilder getThis()

addWorkflowExecutionPostProcessor

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor workflowExecutionPostProcessor)

anonymize

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder anonymize(Boolean anonymize)

clock

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder clock(Clock clock)

formRecordLockContext

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder formRecordLockContext(IFormRecordLockContext formRecordLockContext)

locale

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder locale(Locale locale)

user

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder user(IUser user)

workflowExecutionPostProcessors

@CanIgnoreReturnValue
public UserInvocationEventDataBuilder workflowExecutionPostProcessors(Iterable<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors)

user

@Deprecated
@CanIgnoreReturnValue
public UserInvocationEventDataBuilder user(Benutzer user)

Deprecated.