Package de.xima.fc.api.workflow

Class WorkflowAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.workflow.WorkflowAPI

public class WorkflowAPI
extends ASubAPI

API for initiating the workflow.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
WorkflowAPI()

Method Summary

Modifier and Type	Method	Description
IWorkflowResponse	initCorrectionWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer user)	Deprecated. Use methods of the new workflow engine.
IWorkflowResponse	initCorrectionWorkflow(UserContext uc, Vorgang vorgang, Status status, IUser user)	Deprecated. Use methods of the new workflow engine.
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 user)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer user, boolean anonymize)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer user, SessionAttributes sessionAttributes)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer user, Map<String,Serializable> sessionAttributes)	Deprecated. Use methods of the new workflow engine, such as triggerEvent(UserContext, IFormRecordProvidingEvent).
IWorkflowResponse	initWorkflow(UserContext uc, Vorgang vorgang, Status status, Benutzer user, Map<String,Serializable> sessionAttributes, 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 if necessary

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowAPI

public WorkflowAPI()

Method Detail

triggerEvent

@Nonnull
public 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

public IDoiVerificationResult verifyDoubleOptIn(UserContext uc,
                                                IDoiVerificationEventData eventData)

Verifies the Double Opt-In of the formRecord and executes the workflow tasks if necessary

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 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.

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 user,
                                      SessionAttributes sessionAttributes)

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.

Returns:

The result of the workflow invocation.

initWorkflow

@Deprecated
public IWorkflowResponse initWorkflow(UserContext uc,
                                      Vorgang vorgang,
                                      Status status,
                                      Benutzer user,
                                      Map<String,Serializable> sessionAttributes,
                                      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.

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 user,
                                      Map<String,Serializable> sessionAttributes)

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.

Returns:

The result of the workflow invocation.

initCorrectionWorkflow

@Deprecated
public IWorkflowResponse initCorrectionWorkflow(UserContext uc,
                                                Vorgang vorgang,
                                                Status status,
                                                IUser user)

Deprecated.

Use methods of the new workflow engine.

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.

Returns:

The result of the workflow invocation.

initCorrectionWorkflow

@Deprecated
public IWorkflowResponse initCorrectionWorkflow(UserContext uc,
                                                Vorgang vorgang,
                                                Status status,
                                                Benutzer user)

Deprecated.

Use methods of the new workflow engine.

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.

Returns:

The result of the workflow invocation.

initWorkflow

@Deprecated
public IWorkflowResponse initWorkflow(UserContext uc,
                                      Vorgang vorgang,
                                      Status status,
                                      Benutzer user)

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.

Returns:

The result of the workflow invocation.

initWorkflow

@Deprecated
public IWorkflowResponse initWorkflow(UserContext uc,
                                      Vorgang vorgang,
                                      Status status,
                                      Benutzer user,
                                      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.

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

Returns:

The result of the workflow invocation.

initWorkflow

@Deprecated
public 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
public 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.