Package de.xima.fc.handler.workflow

Class WorkflowHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.workflow.WorkflowHandler

All Implemented Interfaces:

IAPIHandler, IGenericHandler, IWorkflowHandler, Serializable

public class WorkflowHandler
extends GenericHandler
implements IWorkflowHandler

Methods for initiating the workflow for a given form record.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class de.xima.fc.handler.entity.GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
WorkflowHandler()

Method Summary

Modifier and Type	Method	Description
IWorkflowResponse	initWorkflow(WorkflowStartingContext wfsctx)	Deprecated. Use the new workflow engine.
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer currentUser, Map<String,Serializable> sessionAttributes, boolean isCorrection, boolean anonymize)	Deprecated. Use the new workflow engine.
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, IUser user, Map<String,Serializable> sessionAttributes, boolean isCorrection, boolean anonymize)	Deprecated. Use the new workflow engine.
IRemoteEventExecutionResult	triggerEvent(UserContext uc, IFormRecordProvidingEvent eventData)
IWorkflowResponse	verifyAndInitWorkflow(UserContext uc, WorkflowStartingContext wfsCtx)	Deprecated. Use the new workflow engine.
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 class de.xima.fc.handler.entity.GenericHandler

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

Methods inherited from class de.xima.fc.handler.AMSApiHandler

getName

Methods inherited from class java.lang.Object

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

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

Constructor Details

WorkflowHandler

public WorkflowHandler()

Method Details

triggerEvent

public IRemoteEventExecutionResult triggerEvent(UserContext uc,
 IFormRecordProvidingEvent eventData)

Specified by:

triggerEvent in interface IWorkflowHandler

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

public IDoiVerificationResult verifyDoubleOptIn(UserContext uc,
 IDoiVerificationEventData eventData)

Description copied from interface: IWorkflowHandler

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

Specified by:

verifyDoubleOptIn in interface IWorkflowHandler

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
public IWorkflowResponse initWorkflow(UserContext uc,
 Vorgang vorgang,
 Status status,
 IUser user,
 Map<String,Serializable> sessionAttributes,
 boolean isCorrection,
 boolean anonymize)

Deprecated.

Use the new workflow engine. Use the WorkflowEventDataFactory to create the event data, then use WorkflowEventRunner to trigger a workflow chain.

Specified by:

initWorkflow in interface IWorkflowHandler

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
public IWorkflowResponse initWorkflow(UserContext uc,
 Vorgang vorgang,
 Status status,
 Benutzer currentUser,
 Map<String,Serializable> sessionAttributes,
 boolean isCorrection,
 boolean anonymize)

Deprecated.

Use the new workflow engine. Use the WorkflowEventDataFactory to create the event data, then use WorkflowEventRunner to trigger a workflow chain.

Specified by:

initWorkflow in interface IWorkflowHandler

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.

initWorkflow

@Deprecated
public IWorkflowResponse initWorkflow(WorkflowStartingContext wfsctx)

Deprecated.

Use the new workflow engine. Use the WorkflowEventDataFactory to create the event data, then use WorkflowEventRunner to trigger a workflow chain.

Specified by:

initWorkflow in interface IWorkflowHandler

Parameters:

wfsctx - Data that is passed to the workflow.

Returns:

The result of the workflow invocation.

verifyAndInitWorkflow

@Deprecated
public IWorkflowResponse verifyAndInitWorkflow(UserContext uc,
 WorkflowStartingContext wfsCtx)

Deprecated.

Use the new workflow engine. Use the WorkflowEventDataFactory to create the event data, then use WorkflowEventRunner to trigger a workflow chain.

Description copied from interface: IWorkflowHandler

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

Specified by:

verifyAndInitWorkflow in interface IWorkflowHandler

Parameters:

uc - User context for database transactions.

wfsCtx - Data that is passed to the workflow.

Returns:

The result of the workflow invocation.