Package de.xima.fc.handler.interfaces.workflow

Interface IWorkflowHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

WorkflowHandler

public interface IWorkflowHandler
extends IGenericHandler

API Handler for interacting and initializing the workflow for a form record.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IWorkflowResponse	initWorkflow(WorkflowStartingContext startingContext)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer currentUser, Map<String,Serializable> sessionAttributes, boolean isCorrection, boolean anonymize)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, IUser user, Map<String,Serializable> sessionAttributes, boolean isCorrection, boolean anonymize)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IRemoteEventExecutionResult	triggerEvent(UserContext uc, IFormRecordProvidingEvent eventData)
IWorkflowResponse	verifyAndInitWorkflow(UserContext uc, WorkflowStartingContext startingContext)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IDoiVerificationResult	verifyDoubleOptIn(UserContext uc, IDoiVerificationEventData eventData)	Verifies the Double Opt-In of the formRecord and executes the workflow tasks with triggers of type EWorkflowTriggerType.FC_DOI_VERIFIED

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Details

triggerEvent

IRemoteEventExecutionResult triggerEvent(UserContext uc,
 IFormRecordProvidingEvent eventData)

Parameters:

uc - User context for accessing the database.

eventData - Data with the event that occurred. All WorkflowTrigger responding to this event are fire and the corresponding WorkflowTask are run.

Returns:

The result of running the workflow.

verifyDoubleOptIn

IDoiVerificationResult verifyDoubleOptIn(UserContext uc,
 IDoiVerificationEventData eventData)

Verifies the Double Opt-In of the formRecord and executes the workflow tasks with triggers of type EWorkflowTriggerType.FC_DOI_VERIFIED

Parameters:

uc - User context for accessing the database.

eventData - holding information necessary for executing the verification event

Returns:

the result of executing the Double Opt-In event

initWorkflow

@Deprecated
IWorkflowResponse initWorkflow(WorkflowStartingContext startingContext)

Deprecated.

Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).

Parameters:

startingContext - Data that is passed to the workflow.

Returns:

The result of the workflow invocation.

verifyAndInitWorkflow

@Deprecated
IWorkflowResponse verifyAndInitWorkflow(UserContext uc,
 WorkflowStartingContext startingContext)

Deprecated.

Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).

Verifies the double opt-in process has been completed and initiates the workflow if it is.

Parameters:

uc - User context for database transactions.

startingContext - Data that is passed to the workflow.

Returns:

The result of the workflow invocation.

initWorkflow

@Deprecated
IWorkflowResponse initWorkflow(UserContext uc,
 Vorgang vorgang,
 Status status,
 IUser user,
 Map<String,Serializable> sessionAttributes,
 boolean isCorrection,
 boolean anonymize)

Deprecated.

Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).

Parameters:

uc - User context for database transactions.

vorgang - Form record for which to run the workflow.

status - New target state with actions to run.

user - User for checking permissions.

sessionAttributes - HTTP session attributes made available to the workflow context.

isCorrection - true if the workflow was initiated from the inbox, in order to correct the form data.

anonymize - Whether data related to the user is anonymized when persisted.

Returns:

The result of the workflow invocation.

initWorkflow

@Deprecated
IWorkflowResponse initWorkflow(UserContext uc,
 Vorgang vorgang,
 Status status,
 Benutzer currentUser,
 Map<String,Serializable> sessionAttributes,
 boolean isCorrection,
 boolean anonymize)

Deprecated.

Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).

Parameters:

uc - User context for database transactions.

vorgang - Form record for which to run the workflow.

status - New target state with actions to run.

currentUser - User for checking permissions.

sessionAttributes - HTTP session attributes made available to the workflow context.

isCorrection - true if the workflow was initiated from the inbox, in order to correct the form data.

anonymize - Whether data related to the user is anonymized when persisted.

Returns:

The result of the workflow invocation.