Interface IFcFillWordDescriptors

All Superinterfaces:
IExecutionResultDescriptor, IRefinedExecutionResultDescriptor<FcFillWordProps>
All Known Implementing Classes:
FcFillWordHandler
public interface IFcFillWordDescriptors
The result descriptors for the data returned by the EWorkflowNodeType.FC_FILL_WORD action.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Field Details

  • Method Details

    • extractSingleFileProvision

      default IFileProvision extractSingleFileProvision(FcFillWordProps props)

    • getAttachmentAndFileDescriptorI18nPrefix

      default String getAttachmentAndFileDescriptorI18nPrefix()

    • getErrorValueDescriptors

      default Map<String, IValueDescriptor<?,?>> getErrorValueDescriptors(IValueDescriptorFactory f)
      Description copied from interface: IExecutionResultDescriptor
      The descriptors for the different error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type. 
      var connectTimeoutError = factory.recordBuilder().requiredProperty("connectTimeoutMs", factory.integer());
var readTimeoutError = factory.recordBuilder().requiredProperty("readTimeoutMs", factory.integer());
return Map.of("CONNECT_TIMEOUT", connectTimeoutError, "READ_TIMEOUT", readTimeoutError);
      The example above uses a different set of data each type of error.

      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:
      getErrorValueDescriptors 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).

    • getSoftErrorValueDescriptors

      default Map<String, IValueDescriptor<?,?>> getSoftErrorValueDescriptors(IValueDescriptorFactory f)
      Description copied from interface: IExecutionResultDescriptor
      The descriptors 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. 
      var missingUploadError = factory.recordBuilder().requiredProperty("elementName", factory.string());
var clientError = factory.recordBuilder().requiredProperty("statusCode", factory.integer());
return Map.of("MISSING_UPLOAD", missingUploadError, "CLIENT_ERROR", clientError);
      The example above uses a different data type for each type of error.

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

      Specified by:
      getSoftErrorValueDescriptors 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 factory)
      Description copied from interface: IExecutionResultDescriptor
      Creates the value descriptor for the data that is made available to the workflow when the node was executed successfully.
      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 data provided by the node after having been executed successfully.

    • getAttachmentAndFileContentTypes

      default Set<String> getAttachmentAndFileContentTypes()
      Gets the content types of the attachments and files that can be produced by an execution of the node. See FileListDescriptor.getContentTypes()
      Returns:
      The content types of the attachments and files that can be produced by an execution of the node.

    • getAttachmentValueDescriptor

      default IAttachmentValueDescriptor getAttachmentValueDescriptor()
      Description copied from interface: IExecutionResultDescriptor
      Creates the descriptor for the attachment or attachments that are created when the node is executed. Should return null when the node never creates attachments.
      Specified by:
      getAttachmentValueDescriptor in interface IExecutionResultDescriptor
      Returns:
      The descriptor for the attachment or attachments made available after the node was executed.

    • getAttachmentValueDescriptor

      default IAttachmentValueDescriptor getAttachmentValueDescriptor(IRefinedExecutionResultDescriptorParams<FcFillWordProps> params)
      Description copied from interface: IRefinedExecutionResultDescriptor
      Same as getAttachmentValueDescriptor without data, but refined depending on the current node's configuration.
      Specified by:
      getAttachmentValueDescriptor in interface IRefinedExecutionResultDescriptor<Model>
      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.

    • getFileValueDescriptor

      default IFileValueDescriptor getFileValueDescriptor()
      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.