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

Interface IFcCompressAsZipDescriptors

All Superinterfaces:

IExecutionResultDescriptor

All Known Implementing Classes:

FcCompressAsZipHandler

public interface IFcCompressAsZipDescriptors
extends IExecutionResultDescriptor

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

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_COMPRESSED_SIZE	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

Method Summary

Modifier and Type	Method	Description
default IAttachmentValueDescriptor	getAttachmentValueDescriptor()
default IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory f)	The union descriptor for the different error types that may occur when the node is executed.
default IFileValueDescriptor	getFileValueDescriptor()
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 f)

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

getAlwaysValueDescriptor

Field Detail

ATTR_COMPRESSED_SIZE

static final String ATTR_COMPRESSED_SIZE

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

Constant Field Values

Method Detail

getAttachmentValueDescriptor

default IAttachmentValueDescriptor getAttachmentValueDescriptor()

Specified by:

getAttachmentValueDescriptor in interface IExecutionResultDescriptor

Returns:

Descriptor for the attachment or attachments that are created when the node is executed. Should return null when the node never creates attachments.

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory f)

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:

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 failed (such as by throwing an exception).

getFileValueDescriptor

default IFileValueDescriptor getFileValueDescriptor()

Specified by:

getFileValueDescriptor in interface IExecutionResultDescriptor

Returns:

Descriptor for the file or files that are created and made available to other actions when the node is executed. Should return null when the node provides no files.

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.

@implNote This interface provides a default implementation that returns an empty descriptor for backwards compatibility so as not to break existing implementation. However, all existing implementations are strongly advised to override and implement this method. The default implementation may be removed at some point.

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 f)

Specified by:

getSuccessValueDescriptor in interface IExecutionResultDescriptor

Parameters:

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