Package de.xima.fc.interfaces.workflow.execution

Interface IRefinedExecutionResultDescriptor<Model>

Type Parameters:

Model - Type of the properties model for the node.

All Known Subinterfaces:

IBaseActionClientHandlerNode<TData>, IBaseActionNode<TData>, IBaseConditionClientHandlerNode<TData>, IBaseDoUntilLoopClientHandlerNode<TData>, IBaseWhileLoopClientHandlerNode<TData>, IBeanValidatingNode<TData>, IBuiltinNodeType<TData>, IDefaultClientHandlerNode<TData>, IExecutingLikeActionNode<Model>, IExecutingLikeBinarySelectionNode<TData>, IExecutingLikeControlTransferNode<TData>, IExecutingLikeExceptionHandlerNode<TData>, IExecutingLikeMultiSwitchNode<TData>, IExecutingLikePostTestLoopNode<TData>, IExecutingLikePreTestLoopNode<TData>, IExecutingLikeReturningActionNode<TData>, IExecutingLikeReturnNode<TData>, IExecutingLikeSequenceNode<TData>, IExecutingLikeThrowNode<TData>, IFcCompressAsZipDescriptors, IFcCreateTextFileDescriptors, IFcDecodeBase64Descriptor, IFcEmailDescriptors, IFcExportFormRecordChatsDescriptors, IFcExportToPersistenceDescriptors, IFcExportToXmlDescriptors, IFcFillPdfDescriptors, IFcFillWordDescriptors, IFcForEachLoopDescriptors, IFcHttpRequestDescriptors, IFcProcessLogPdfDescriptor, IFcPromptQueryDescriptors, IFcProvideResourceDescriptors, IFileProviding<TData>, IHierarchyValidatingNode<TData>, ILoopStatementMustLoopValidating<TData>, IMultipleCheckPropertiesNode<TData>, INodeHandler<Model>, IOfficialHelpPageNode<TData>, IPluginActionNodeHandler<TData>, IPluginConditionNodeHandler<TData>, IPluginDoUntilLoopNodeHandler<TData,TState>, IPluginWhileLoopNodeHandler<TData,TState>, IResultlessNode<TData>, ISemverUpdatingNode<TData>, ISingleBaseActionBuiltinNodePrototype<TData>, ISingleBaseActionNodePrototype<TData>, ISingleBaseConditionNodePrototype<TData>, ISingleBaseDoUntilLoopNodePrototype<TData>, ISingleBaseWhileLoopNodePrototype<TData>, ISingleBuiltinNodePrototype<TData>, de.xima.fc.workflow.retval.node.ISingleFileProvisionFileDescriptor<Model>, ISingleNodePrototype<TData>

All Known Implementing Classes:

APluginActionNodeHandler, APluginConditionNodeHandler, APluginDoUntilLoopNodeHandler, APluginWhileLoopNodeHandler, FcBreakHandler, FcChangeFormAvailabilityHandler, FcChangeFormRecordChatActivenessHandler, FcChangeFormValueHandler, FcChangeStateHandler, FcCompressAsZipHandler, FcContinueHandler, FcCopyFormRecordHandler, FcCounterHandler, FcCreateTextFileHandler, FcDecodeBase64Handler, FcDeleteAttachmentHandler, FcDeleteFormRecordHandler, FcDoiInitHandler, FcDoUntilLoopHandler, FcEmailHandler, FcEmptyHandler, FcEncodeBase64Handler, FcExperimentHandler, FcExportFormRecordChatsHandler, FcExportToPersistenceHandler, FcExportToXmlHandler, FcFillPdfHandler, FcFillWordHandler, FcForEachLoopHandler, FcHttpRequestHandler, FcImportFormValueFromXmlHandler, FcLdapQueryHandler, FcLogEntryHandler, FcMoveFormRecordToInboxHandler, FcMultipleConditionHandler, FcProcessHistoryPdfHandler, FcProcessLogPdfHandler, FcPromptQueryHandler, FcProvideResourceHandler, FcQueueTaskHandler, FcRedirectHandler, FcRenewProcessIdHandler, FcReturnFileHandler, FcReturnHandler, FcSaveToFileSystemHandler, FcSaveToWebDavHandler, FcSendFormRecordMessageHandler, FcSequenceHandler, FcSetFormRecordPasswordHandler, FcSetSavedFlagHandler, FcShowTemplateHandler, FcSqlStatementHandler, FcSwitchCaseHandler, FcSwitchDefaultHandler, FcSwitchHandler, FcThrowExceptionHandler, FcVoidHandler, FcWhileLoopHandler, FcWithFormElementContextHandler, FcWriteFormRecordAttrHandler, FormUpdateThroughJsonNodePlugin, RedirectToClientInboxNodePlugin, RedirectToFormRecordNodePlugin

public interface IRefinedExecutionResultDescriptor<Model>

See IExecutionResultDescriptor for more details. This is similar, but allows the execution result to be refined depending on the node's configuration, i.e. the contents of its property model. For example, a loop node might let the user choose whether to loop over a list of files or a list of strings. Depending on the user's choice, the node's current value might change. By defining a value descriptor for each case, we can show the user only the relevant data for that case.

All value descriptors must be compatible with the general descriptors returned by IExecutionResultDescriptor. The final value descriptor is obtained by taking the intersection of the general value descriptor with the refined value descriptor, i.e.:

 intersect(getSuccessValueDescriptor(), getSuccessValueDescriptor(model))
 intersect(getFileValueDescriptor(), getFileValueDescriptor(model))
 

For example, you can use a general value descriptor that allows for either strings or numbers ( union: string | number). Depending on the node's configuration, the refined value descriptor could be either just a string or just a number. Or you can use a general file descriptor that allows PDF and Word documents. Depending on the node's configuration, the refined file descriptor could allow either just a PDF document or just a Word document.

On the other hand, if general value descriptor were to allow only strings and the refined value descriptor were to allow only booleans, the final value descriptor would evaluate to intersect(boolean, string) = void. In other words, the node could not provide data. Any attempts to provide data when the node is executed will be ignored by the workflow engine. Similarly, if the general file value descriptor were to allow only PDF documents and the refined file value descriptor were to allow only Word documents, the final file value descriptor would evaluate to intersect(PDF, Word) = empty, so no files would be allowed.

Note: The value and file descriptors are also used by the UI to inform the UI about the possible return values of a node. By ignoring all provided values incompatible with the value and file descriptor, the workflow engine ensures that the UI agrees with the actual behavior.

Since:

8.2.0

Method Summary

Modifier and Type	Method	Description
default IValueDescriptor<?,? extends IValueBuilder<?>>	getAlwaysValueDescriptor(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<Model> params)	Same as getAlwaysValueDescriptor without data, but refined depending on the current node's configuration.
default IValueDescriptor<?,? extends IValueBuilder<?>>	getAlwaysValueDescriptor(IValueDescriptorFactory factory, Model data)	Deprecated. Use / implement getAlwaysValueDescriptor(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams).
default IAttachmentValueDescriptor	getAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)	Same as getAttachmentValueDescriptor without data, but refined depending on the current node's configuration.
default IAttachmentValueDescriptor	getAttachmentValueDescriptor(Model data)	Deprecated. Use / implement getAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams).
default IAttachmentValueDescriptor	getCurrentAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)	Same as getCurrentAttachmentValueDescriptor without data, but refined depending on the current node's configuration.
default IAttachmentValueDescriptor	getCurrentAttachmentValueDescriptor(Model data)	Deprecated. Use / implement getCurrentAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams).
default IFileValueDescriptor	getCurrentFileValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)	Same as getCurrentFileValueDescriptor without data, but refined depending on the current node's configuration.
default IFileValueDescriptor	getCurrentFileValueDescriptor(Model data)	Deprecated. Use / implement getCurrentFileValueDescriptor(IRefinedExecutionResultDescriptorParams).
default IValueDescriptor<?,? extends IValueBuilder<?>>	getCurrentValueDescriptor(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<Model> params)	Same as getCurrentValueDescriptor without data, but refined depending on the current node's configuration.
default IValueDescriptor<?,? extends IValueBuilder<?>>	getCurrentValueDescriptor(IValueDescriptorFactory factory, Model data)	Deprecated. Use / implement getCurrentValueDescriptor(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams).
default IUnionValueDescriptor	getErrorValueDescriptor(IValueDescriptorFactory factory, Model data)	Deprecated. Implement getErrorValueDescriptors(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams) instead.
default Map<String,IValueDescriptor<?,?>>	getErrorValueDescriptors(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<Model> params)	Same as getErrorValueDescriptors without data, but refined depending on the current node's configuration.
default IFileValueDescriptor	getFileValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)	Same as getFileValueDescriptor without data, but refined depending on the current node's configuration.
default IFileValueDescriptor	getFileValueDescriptor(Model data)	Deprecated. Use / implement getFileValueDescriptor(IRefinedExecutionResultDescriptorParams).
default IUnionValueDescriptor	getSoftErrorValueDescriptor(IValueDescriptorFactory factory, Model data)	Deprecated. Use / implement getSoftErrorValueDescriptors(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams) instead.
default Map<String,IValueDescriptor<?,?>>	getSoftErrorValueDescriptors(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<Model> params)	Same as getSoftErrorValueDescriptors without data, but refined depending on the current node's configuration.
default IValueDescriptor<?,? extends IValueBuilder<?>>	getSuccessValueDescriptor(IValueDescriptorFactory factory, IRefinedExecutionResultDescriptorParams<Model> params)	Same as getSuccessValueDescriptor without data, but refined depending on the current node's configuration.
default IValueDescriptor<?,? extends IValueBuilder<?>>	getSuccessValueDescriptor(IValueDescriptorFactory factory, Model data)	Deprecated. Use / implement getSuccessValueDescriptor(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams).

Method Detail

getAlwaysValueDescriptor

@Deprecated
default IValueDescriptor<?,? extends IValueBuilder<?>> getAlwaysValueDescriptor(IValueDescriptorFactory factory,
                                                                                      Model data)

Deprecated.

Use / implement getAlwaysValueDescriptor(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams).

Same as getAlwaysValueDescriptor without data, but refined depending on the current node's configuration.

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.

data - Current properties model of the node.

Returns:

The value descriptor for that data that is made available to the workflow when the node is executed, regardless of whether is succeeded or failed. If null, the non-refined descriptor is used.

getAlwaysValueDescriptor

default IValueDescriptor<?,? extends IValueBuilder<?>> getAlwaysValueDescriptor(IValueDescriptorFactory factory,
                                                                                      IRefinedExecutionResultDescriptorParams<Model> params)

Same as getAlwaysValueDescriptor without data, but refined depending on the current node's configuration.

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.

params - Parameters with the current properties model of the node.

Returns:

The value descriptor for that data that is made available to the workflow when the node is executed, regardless of whether is succeeded or failed. If null, the non-refined descriptor is used.

Since:

8.5.0

getAttachmentValueDescriptor

@Deprecated
default IAttachmentValueDescriptor getAttachmentValueDescriptor(Model data)

Deprecated.

Use / implement getAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams).

Same as getAttachmentValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

data - Current properties model of the node.

Returns:

The descriptor for the attachment or attachment made available after the node was executed. If null , the non-refined descriptor is used.

getAttachmentValueDescriptor

default IAttachmentValueDescriptor getAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)

Same as getAttachmentValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

params - Parameters with the current properties model of the node.

Returns:

The descriptor for the attachment or attachment made available after the node was executed. If null , the non-refined descriptor is used.

Since:

8.5.0

getCurrentAttachmentValueDescriptor

@Deprecated
default IAttachmentValueDescriptor getCurrentAttachmentValueDescriptor(Model data)

Deprecated.

Use / implement getCurrentAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams).

Same as getCurrentAttachmentValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

data - Current properties model of the node.

Returns:

The descriptor for the attachment or attachments made available while the node is being executed. If null, the non-refined descriptor is used.

getCurrentAttachmentValueDescriptor

default IAttachmentValueDescriptor getCurrentAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)

Same as getCurrentAttachmentValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

params - Parameters with the current properties model of the node.

Returns:

The descriptor for the attachment or attachments made available while the node is being executed. If null, the non-refined descriptor is used.

Since:

8.5.0

getCurrentFileValueDescriptor

@Deprecated
default IFileValueDescriptor getCurrentFileValueDescriptor(Model data)

Deprecated.

Use / implement getCurrentFileValueDescriptor(IRefinedExecutionResultDescriptorParams).

Same as getCurrentFileValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

data - Current properties model of the node.

Returns:

The descriptor for the file or files made available while the node is being executed. If null , the non-refined descriptor is used.

getCurrentFileValueDescriptor

default IFileValueDescriptor getCurrentFileValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)

Same as getCurrentFileValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

params - Parameters with the current properties model of the node.

Returns:

The descriptor for the file or files made available while the node is being executed. If null , the non-refined descriptor is used.

Since:

8.5.0

getCurrentValueDescriptor

@Deprecated
default IValueDescriptor<?,? extends IValueBuilder<?>> getCurrentValueDescriptor(IValueDescriptorFactory factory,
                                                                                       Model data)

Deprecated.

Use / implement getCurrentValueDescriptor(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams).

Same as getCurrentValueDescriptor without data, but refined depending on the current node's configuration.

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.

data - Current properties model of the node.

Returns:

The descriptor for data published by the node while it is being executed. If null, the non-refined descriptor is used.

getCurrentValueDescriptor

default IValueDescriptor<?,? extends IValueBuilder<?>> getCurrentValueDescriptor(IValueDescriptorFactory factory,
                                                                                       IRefinedExecutionResultDescriptorParams<Model> params)

Same as getCurrentValueDescriptor without data, but refined depending on the current node's configuration.

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.

params - Parameters with the current properties model of the node.

Returns:

The descriptor for data published by the node while it is being executed. If null, the non-refined descriptor is used.

Since:

8.5.0

getErrorValueDescriptor

@Deprecated
default IUnionValueDescriptor getErrorValueDescriptor(IValueDescriptorFactory factory,
                                                      Model data)

Deprecated.

Implement getErrorValueDescriptors(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams) instead.

Same as getErrorValueDescriptor without data, but refined depending on the current node's configuration.

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.

data - Current properties model of the node.

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). If null, the non-refined descriptor is used.

getErrorValueDescriptors

default Map<String,IValueDescriptor<?,?>> getErrorValueDescriptors(IValueDescriptorFactory factory,
                                                                               IRefinedExecutionResultDescriptorParams<Model> params)

Same as getErrorValueDescriptors without data, but refined depending on the current node's configuration.

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.

params - Parameters with the current properties model of the node.

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). If null, the non-refined descriptor is used.

Since:

8.5.0

getFileValueDescriptor

@Deprecated
default IFileValueDescriptor getFileValueDescriptor(Model data)

Deprecated.

Use / implement getFileValueDescriptor(IRefinedExecutionResultDescriptorParams).

Same as getFileValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

data - Current properties model of the node.

Returns:

The descriptor for the file or files made available after the node was executed. If null, the non-refined descriptor is used.

getFileValueDescriptor

default IFileValueDescriptor getFileValueDescriptor(IRefinedExecutionResultDescriptorParams<Model> params)

Same as getFileValueDescriptor without data, but refined depending on the current node's configuration.

Parameters:

params - Parameters with the current properties model of the node.

Returns:

The descriptor for the file or files made available after the node was executed. If null, the non-refined descriptor is used.

Since:

8.5.0

getSoftErrorValueDescriptor

@Deprecated
default IUnionValueDescriptor getSoftErrorValueDescriptor(IValueDescriptorFactory factory,
                                                          Model data)

Deprecated.

Use / implement getSoftErrorValueDescriptors(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams) instead.

Same as getSoftErrorValueDescriptor without data, but refined depending on the current node's configuration.

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.

data - Current properties model of the node.

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. If null, the non-refined descriptor is used.

getSoftErrorValueDescriptors

default Map<String,IValueDescriptor<?,?>> getSoftErrorValueDescriptors(IValueDescriptorFactory factory,
                                                                                   IRefinedExecutionResultDescriptorParams<Model> params)

Same as getSoftErrorValueDescriptors without data, but refined depending on the current node's configuration.

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.

params - Parameters with the current properties model of the node.

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. If null, the non-refined descriptor is used.

Since:

8.5.0

getSuccessValueDescriptor

@Deprecated
default IValueDescriptor<?,? extends IValueBuilder<?>> getSuccessValueDescriptor(IValueDescriptorFactory factory,
                                                                                       Model data)

Deprecated.

Use / implement getSuccessValueDescriptor(IValueDescriptorFactory, IRefinedExecutionResultDescriptorParams).

Same as getSuccessValueDescriptor without data, but refined depending on the current node's configuration.

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.

data - Current properties model of the node.

Returns:

The data provided by the node after having been executed successfully. If null, the non-refined descriptor is used.

getSuccessValueDescriptor

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

Same as getSuccessValueDescriptor without data, but refined depending on the current node's configuration.

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.

params - Parameters with the current properties model of the node.

Returns:

The data provided by the node after having been executed successfully. If null, the non-refined descriptor is used.

Since:

8.5.0