IFileProviding (formcycle: bom 8.2.0 API)

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 de.xima.fc.interfaces.workflow.elements.IElementHandler
  CURRENT_HANDLER_VERSION

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
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 de.xima.fc.interfaces.workflow.ICustomParametersUpdateable
updateCustomParams

Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor

Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
execute, getLocalizedTypeName, getNodePrototypes, getPropertiesBeanClass, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding
getType

Methods inherited from interface de.xima.fc.interfaces.workflow.analysis.IWorkflowNodeFlowAnalyzer
createFlowGraph

- Method Detail
  - 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.