Package de.xima.fc.interfaces.workflow.params

Interface INodeExecutionParams<TData>

Type Parameters:

TData - Type of the properties model for the node. See INodeHandler.

public interface INodeExecutionParams<TData>

Interface for the parameters that are passed to INodeHandler.execute(INodeExecutionParams).

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
TData	getData()
WorkflowNode	getNode()
IWorkflowExecutionContext	getWorkflowContext()
INormalCompletionResultBuilder	normalResult()	When the node was executed normally (without an exception and without returning), use this method to create the result and return it.
INodeReturnedExceptionBuilder	returningException()	When the node was executed and you wish to stop the execution of the current workflow task via a return statement, create a returning exception with this method and throw it.
INodeThrewExceptionBuilder	throwingException()	When the node was executed, but an exception did occur, use this method to create a throwing exception and throw it.

Method Detail

getData

TData getData()

Returns:

The custom data of the given node. This is passed for convenience, it the the same as AWorkflowElement.getCustomParameters(), but already deserialized and updated.

getNode

WorkflowNode getNode()

Returns:

The node that needs to be executed.

getWorkflowContext

IWorkflowExecutionContext getWorkflowContext()

Returns:

The workflow context of the current workflow execution. Use this context to access various system related features, such as replacing placeholders, retrieving / writing files, or sending HTTP responses.

normalResult

INormalCompletionResultBuilder normalResult()

When the node was executed normally (without an exception and without returning), use this method to create the result and return it.

Returns:

A builder for a normal completion result.

returningException

INodeReturnedExceptionBuilder returningException()

When the node was executed and you wish to stop the execution of the current workflow task via a return statement, create a returning exception with this method and throw it.

Returns:

A builder for a returning exception.

throwingException

INodeThrewExceptionBuilder throwingException()

When the node was executed, but an exception did occur, use this method to create a throwing exception and throw it. Please note that if you just throw some exception, it will be wrapped in a NodeThrewException.

Returns:

A builder for a throwing exception.