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

Class WorkflowTriggerPropsFactory

java.lang.Object

de.xima.fc.workflow.processor.factory.WorkflowTriggerPropsFactory

public final class WorkflowTriggerPropsFactory
extends Object

Factory methods for creating various kinds of WorkflowTrigger models.

Since:

8.0.1

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
static FcCatchErrorProps	catchError()
static FcDoiVerifiedProps	doiVerified()
static FcDoiVerifiedProps	doiVerified(WorkflowNode targetNode)
static FcDoiVerifiedProps	doiVerified(NodeKey targetNode)
static FcFormSubmitButtonProps	formSubmitButton(String buttonName)	Creates a new model of type EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON that occurs when an a form was submitted via any button with a given name.
static FcInvitationErrorProps	invitationError()	Creates a new model of type EWorkflowTriggerType.FC_INVITATION_ERROR that occurs when an invitation email could not be sent.
static FcInvitationSentProps	invitationSent()	Creates a new model of type EWorkflowTriggerType.FC_INVITATION_SENT that occurs when an invitation was created successfully.
static FcManualProps	manual()	Creates a new model of type EWorkflowTriggerType.FC_MANUAL that occurs when a user initiates it.
static FcManualProps	manual(Iterable<WorkflowState> states, Iterable<BenutzerGruppe> userGroups)	Creates a new model of type EWorkflowTriggerType.FC_MANUAL that occurs when a user initiates it.
static FcQualifiedFormSubmitButtonProps	qualifiedFormSubmitButton(String qualifier, String buttonName)	Creates a new model of type EWorkflowTriggerType.FC_QUALIFIED_FORM_SUBMIT_BUTTON that occurs when an a form was submitted via a specific button of a certain button list element.
static FcStateTimerProps	stateTimer(WorkflowState state, Duration duration)
static FcTimePointProps	timePointExpression(String dateTimeTemplate, String dateTimeFormat, WorkflowState... allowedStates)
static FcTimePointProps	timePointExpression(String dateTimeTemplate, String dateTimeFormat, ETimePointTriggerOperation offsetOperation, String offsetDuration, ETimePointTriggerDurationUnit offsetUnit, WorkflowState... allowedStates)
static FcTimePointProps	timePointExpressionOrPast(String dateTimeTemplate, String dateTimeFormat, WorkflowState... allowedStates)
static FcTimePointProps	timePointExpressionOrPast(String dateTimeTemplate, String dateTimeFormat, ETimePointTriggerOperation offsetOperation, String offsetDuration, ETimePointTriggerDurationUnit offsetUnit, WorkflowState... allowedStates)
static FcTimePointProps	timePointFixed(Instant instant, Iterable<WorkflowState> allowedStates)	Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at a certain point in time.
static FcTimePointProps	timePointFixed(Instant instant, ZoneId zoneId, Iterable<WorkflowState> allowedStates)	Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at a certain point in time.
static FcTimePointProps	timePointFixed(LocalDateTime dateTime, ZoneId zoneId, Iterable<WorkflowState> allowedStates)	Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at a certain point in time.
static FcTimePointProps	timePointFixedOrPast(Instant instant, Iterable<WorkflowState> allowedStates)	Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at or after a certain point in time.
static FcTimePointProps	timePointFixedOrPast(Instant instant, ZoneId zoneId, Iterable<WorkflowState> allowedStates)	Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at or after a certain point in time.
static FcTimePointProps	timePointFixedOrPast(LocalDateTime dateTime, ZoneId zoneId, Iterable<WorkflowState> allowedStates)	Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at or after a certain point in time.
static IUserInvocationTriggerBuilder	userInvocation()	Creates a builder for a new event of type EWorkflowTriggerType.FC_USER_INVOCATION that occurs when a portal user initiates it.

Methods inherited from class java.lang.Object

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

Method Detail

catchError

public static FcCatchErrorProps catchError()

doiVerified

public static FcDoiVerifiedProps doiVerified()

doiVerified

public static FcDoiVerifiedProps doiVerified(NodeKey targetNode)

doiVerified

public static FcDoiVerifiedProps doiVerified(WorkflowNode targetNode)

formSubmitButton

public static FcFormSubmitButtonProps formSubmitButton(String buttonName)

Creates a new model of type EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON that occurs when an a form was submitted via any button with a given name.

Parameters:

buttonName - Name of the submit button to which the trigger should react. Leave empty to react to all submit buttons.

Returns:

A new trigger model for a submit button event.

invitationError

public static FcInvitationErrorProps invitationError()

Creates a new model of type EWorkflowTriggerType.FC_INVITATION_ERROR that occurs when an invitation email could not be sent.

Returns:

A new trigger model for an invitation sent event.

invitationSent

public static FcInvitationSentProps invitationSent()

Creates a new model of type EWorkflowTriggerType.FC_INVITATION_SENT that occurs when an invitation was created successfully.

Returns:

A new trigger model for an invitation sent event.

manual

public static FcManualProps manual()

Creates a new model of type EWorkflowTriggerType.FC_MANUAL that occurs when a user initiates it. Does not restrict the event to a particular state or user group.

Returns:

A new trigger model for a manual event.

manual

public static FcManualProps manual(Iterable<WorkflowState> states,
                                   Iterable<BenutzerGruppe> userGroups)

Creates a new model of type EWorkflowTriggerType.FC_MANUAL that occurs when a user initiates it.

Parameters:

states - States a form record must have for a user to be allowed to initiate the event.

userGroups - User groups a user must be part of for them to be allowed to initiate the event.

Returns:

A new trigger model for a manual event.

userInvocation

public static IUserInvocationTriggerBuilder userInvocation()

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

Returns:

A new trigger model for a user invocation event.

qualifiedFormSubmitButton

public static FcQualifiedFormSubmitButtonProps qualifiedFormSubmitButton(String qualifier,
                                                                         String buttonName)

Creates a new model of type EWorkflowTriggerType.FC_QUALIFIED_FORM_SUBMIT_BUTTON that occurs when an a form was submitted via a specific button of a certain button list element.

Parameters:

qualifier - Qualifier of the submit button, e.g. the name of the button list element.

buttonName - Name of the submit button to which the trigger should react.

Returns:

A new trigger model for a qualified submit button event.

stateTimer

public static FcStateTimerProps stateTimer(WorkflowState state,
                                           Duration duration)

timePointExpression

public static FcTimePointProps timePointExpression(String dateTimeTemplate,
                                                   String dateTimeFormat,
                                                   ETimePointTriggerOperation offsetOperation,
                                                   String offsetDuration,
                                                   ETimePointTriggerDurationUnit offsetUnit,
                                                   WorkflowState... allowedStates)

timePointExpression

public static FcTimePointProps timePointExpression(String dateTimeTemplate,
                                                   String dateTimeFormat,
                                                   WorkflowState... allowedStates)

timePointExpressionOrPast

public static FcTimePointProps timePointExpressionOrPast(String dateTimeTemplate,
                                                         String dateTimeFormat,
                                                         ETimePointTriggerOperation offsetOperation,
                                                         String offsetDuration,
                                                         ETimePointTriggerDurationUnit offsetUnit,
                                                         WorkflowState... allowedStates)

timePointExpressionOrPast

public static FcTimePointProps timePointExpressionOrPast(String dateTimeTemplate,
                                                         String dateTimeFormat,
                                                         WorkflowState... allowedStates)

timePointFixed

public static FcTimePointProps timePointFixed(Instant instant,
                                              Iterable<WorkflowState> allowedStates)

Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at a certain point in time.

Parameters:

instant - Instant at which the event occurs.

allowedStates - States to which to restrict the event. Leave empty for all states.

Returns:

A new trigger model for a time point event.

timePointFixed

public static FcTimePointProps timePointFixed(Instant instant,
                                              ZoneId zoneId,
                                              Iterable<WorkflowState> allowedStates)

Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at a certain point in time.

Parameters:

instant - Instant at which the event occurs.

zoneId - Time zone to use.

allowedStates - States to which to restrict the event. Leave empty for all states.

Returns:

A new trigger model for a time point event.

timePointFixed

public static FcTimePointProps timePointFixed(LocalDateTime dateTime,
                                              ZoneId zoneId,
                                              Iterable<WorkflowState> allowedStates)

Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at a certain point in time.

Parameters:

dateTime - Date and time at which the event occurs.

zoneId - Time zone to use.

allowedStates - States to which to restrict the event. Leave empty for all states.

Returns:

A new trigger model for a time point event.

timePointFixedOrPast

public static FcTimePointProps timePointFixedOrPast(Instant instant,
                                                    Iterable<WorkflowState> allowedStates)

Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at or after a certain point in time.

Parameters:

instant - Instant at which the event occurs.

allowedStates - States to which to restrict the event. Leave empty for all states.

Returns:

A new trigger model for a time point event.

timePointFixedOrPast

public static FcTimePointProps timePointFixedOrPast(Instant instant,
                                                    ZoneId zoneId,
                                                    Iterable<WorkflowState> allowedStates)

Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at or after a certain point in time.

Parameters:

instant - Instant at which the event occurs.

zoneId - Time zone to use.

allowedStates - States to which to restrict the event. Leave empty for all states.

Returns:

A new trigger model for a time point event.

timePointFixedOrPast

public static FcTimePointProps timePointFixedOrPast(LocalDateTime dateTime,
                                                    ZoneId zoneId,
                                                    Iterable<WorkflowState> allowedStates)

Creates a new model of type EWorkflowTriggerType.FC_TIME_POINT that occurs at or after a certain point in time.

Parameters:

dateTime - Date and time at which the event occurs.

zoneId - Time zone of the date time.

allowedStates - States to which to restrict the event. Leave empty for all states.

Returns:

A new trigger model for a time point event.