Package de.xima.fc.interfaces.workflow.mixin

Interface IResultlessNode<TData>

Type Parameters:
TData - Type of the node's properties model.
All Superinterfaces:
ICustomParametersUpdateable, IElementHandler<TData,WorkflowNode>, IExecutionResultDescriptor, INodeHandler<TData>, IResourceBundleLocator, IWorkflowElementTypeProviding, IWorkflowNodeFlowAnalyzer<TData>, IWorkflowNodeTypeProviding
All Known Implementing Classes:
FcDeleteFormRecordHandler, FcEmptyHandler, FcExperimentHandler, FcMultipleConditionHandler, FcReturnHandler, FcSequenceHandler, FcSwitchCaseHandler, FcSwitchDefaultHandler, FcSwitchHandler
public interface IResultlessNode<TData> extends INodeHandler<TData>, IExecutionResultDescriptor
Mixin for nodes that neither return a result nor do throw an error.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • 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);
      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:
      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 the 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.