Package de.xima.fc.workflow.retval.node

Interface IFcRedirectDescriptors

All Superinterfaces:

IExecutionResultDescriptor

All Known Implementing Classes:

FcRedirectHandler

public interface IFcRedirectDescriptors
extends IExecutionResultDescriptor

The result descriptors for the data returned by the EWorkflowNodeType.FC_REDIRECT action.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ERROR_MESSAGE	Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)
static String	ATTR_URL_HOST	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_URL_PATH	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_URL_PORT	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_URL_PROTOCOL	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)
static String	ATTR_URL_QUERY_STRING	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

Method Summary

Modifier and Type	Method	Description
default IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory factory)	The union descriptor for the different error types that may occur when the node is executed.
default IUnionValueDescriptor<String>	getSoftErrorValueDescriptor(IValueDescriptorFactory f)	The union descriptor for the different soft error types that may occur when the node is executed.
default IValueDescriptor<?,? extends IValueBuilder<?>>	getSuccessValueDescriptor(IValueDescriptorFactory factory)

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor

getAlwaysValueDescriptor, getFileValueDescriptor

Field Detail

ATTR_URL_QUERY_STRING

static final String ATTR_URL_QUERY_STRING

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_URL_PROTOCOL

static final String ATTR_URL_PROTOCOL

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_URL_HOST

static final String ATTR_URL_HOST

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_URL_PORT

static final String ATTR_URL_PORT

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_URL_PATH

static final String ATTR_URL_PATH

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

ATTR_ERROR_MESSAGE

static final String ATTR_ERROR_MESSAGE

Name of the corresponding property of the getErrorValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

Method Detail

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory factory)

Description copied from interface: IExecutionResultDescriptor

The union descriptor for the different error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type.

 factory.recordBuilder() //
     .requiredProperty("errorCode", factory.integer()) //
     .requiredProperty("errorMessage", factory.string()) //
     .requiredProperty("localizedMessage", factory.integer());
 return factory.add("CONNECT_TIMEOUT", error) //
     .add("READ_TIMEOUT", error);
 

The example above uses the same data type for each error, but you can return different data depending on the error type.

Note that you do not have to include a general error code. When the execute method of a node handler throws an unhandled (runtime) exception, the error code CmnConst.Workflow.ERROR_CODE_GENERAL is set automatically.

Specified by:

getErrorValueDescriptor in interface IExecutionResultDescriptor

Parameters:

factory - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node failed (such as by throwing an exception).

getSoftErrorValueDescriptor

default IUnionValueDescriptor<String> getSoftErrorValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

The union descriptor for the different soft error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type.

 factory.recordBuilder() //
     .requiredProperty("errorCode", factory.integer()) //
     .requiredProperty("errorMessage", factory.string()) //
     .requiredProperty("localizedMessage", factory.integer());
 return factory.add("MISSING_UPLOAD", error) //
     .add("CLIENT_ERROR", error);
 

The example above uses the same data type for each error, but you can return different data depending on the error type.

Specified by:

getSoftErrorValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node was successful, but contains one or more soft errors.

getSuccessValueDescriptor

default IValueDescriptor<?,? extends IValueBuilder<?>> getSuccessValueDescriptor(IValueDescriptorFactory factory)

Specified by:

getSuccessValueDescriptor in interface IExecutionResultDescriptor

Parameters:

factory - Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The value descriptor for that data that is made available to the workflow when the node is executed successfully.