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

Interface IFcCounterDescriptor

All Superinterfaces:

IExecutionResultDescriptor

All Known Implementing Classes:

FcCounterHandler

public interface IFcCounterDescriptor
extends IExecutionResultDescriptor

The result descriptors for data returned by EWorkflowNodeType.FC_COUNTER actions.

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 getSuccessValueDescriptor(IValueDescriptorFactory).
static String	ATTR_SUCCESS_NEW_VALUE	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory).
static String	ATTR_SUCCESS_OLD_VALUE	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory).
static String	ATTR_SUCCESS_WAS_RESET	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 IValueDescriptor<?,? extends IValueBuilder<?>>	getSuccessValueDescriptor(IValueDescriptorFactory factory)

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

getAlwaysValueDescriptor, getFileValueDescriptor

Field Detail

ATTR_ERROR_MESSAGE

static final String ATTR_ERROR_MESSAGE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory). Error message when the counter could not be modified.

See Also:

Constant Field Values

ATTR_SUCCESS_NEW_VALUE

static final String ATTR_SUCCESS_NEW_VALUE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory). New value of the counter after it was modified by this action.

See Also:

Constant Field Values

ATTR_SUCCESS_OLD_VALUE

static final String ATTR_SUCCESS_OLD_VALUE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory). Old value of the counter before it was modified by this action.

See Also:

Constant Field Values

ATTR_SUCCESS_WAS_RESET

static final String ATTR_SUCCESS_WAS_RESET

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory). Whether the counter was reset by this action.

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) //
     .add("GENERAL", 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:

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 that data that is made available to the workflow when the execution of the node failed (such as by throwing an exception).

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.