Interface IFileProviding<TData>

Type Parameters:

TData - Type of the node's properties model.

All Superinterfaces:

ICustomParametersUpdateable, IElementHandler<TData, WorkflowNode>, IExecutionResultDescriptor, INodeHandler<TData>, IRefinedExecutionResultDescriptor<TData>, IResourceBundleLocator, IWorkflowElementTypeProviding, IWorkflowNodeFlowAnalyzer<TData>, IWorkflowNodeTypeProviding

@Deprecated
public interface IFileProviding<TData>
extends INodeHandler<TData>

Deprecated.

This should be implemented together with getSuccessValueDescriptor etc., e.g. in a separate specific mixin interface for the node handler.

Mixin interface for all node handlers that create files when executed. Implements getFileValueDescriptor() with a sensible default.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface IElementHandler

CURRENT_HANDLER_VERSION

Method Summary

Modifier and Type	Method	Description
default IFileValueDescriptor	getFileValueDescriptor()	Deprecated. Creates the descriptor for the file or files that are created and made available to other actions when the node is executed.

Methods inherited from interface ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface IElementHandler

extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getFilterCriteriaForObjects, getHelpPageLocation, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readObjectReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writeObjectReferences, writePlaceholders

Methods inherited from interface IExecutionResultDescriptor

getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getErrorValueDescriptors, getSoftErrorValueDescriptor, getSoftErrorValueDescriptors, getSuccessValueDescriptor

Methods inherited from interface INodeHandler

execute, getBpmnModeler, getLocalizedTypeName, getNodePrototypes, getPropertiesBeanClass, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

Methods inherited from interface IRefinedExecutionResultDescriptor

getAlwaysValueDescriptor, getAlwaysValueDescriptor, getAttachmentValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getErrorValueDescriptors, getFileValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSoftErrorValueDescriptors, getSuccessValueDescriptor, getSuccessValueDescriptor

Methods inherited from interface IWorkflowElementTypeProviding

getType

Methods inherited from interface IWorkflowNodeFlowAnalyzer

createFlowGraph

Method Details

getFileValueDescriptor

default IFileValueDescriptor getFileValueDescriptor()

Deprecated.

Description copied from interface: IExecutionResultDescriptor

Creates the 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 node files.

Specified by:

getFileValueDescriptor in interface IExecutionResultDescriptor

Returns:

The descriptor for the file or files made available after the node was executed.