Interface IFcDeleteAttachmentDescriptors

All Superinterfaces:
IExecutionResultDescriptor
All Known Implementing Classes:
FcDeleteAttachmentHandler
public interface IFcDeleteAttachmentDescriptors extends IExecutionResultDescriptor
The result descriptors for the data returned by the EWorkflowNodeType.FC_DELETE_ATTACHMENT action.
Since:
8.1.0
Author:
XIMA MEDIA GmbH

  • Field Details

    • ATTR_DELETED_ATTACHMENTS

      static final String ATTR_DELETED_ATTACHMENTS
      Name of the property in the result descriptors for the attachments that were deleted.
      See Also:

    • ATTR_NOT_DELETED_ATTACHMENTS

      static final String ATTR_NOT_DELETED_ATTACHMENTS
      Name of the property in the result descriptors for the attachments that were not deleted.
      See Also:

    • ATTR_NOT_DELETED_ATTACHMENT_ATTACHMENT

      static final String ATTR_NOT_DELETED_ATTACHMENT_ATTACHMENT
      Name of the property in the result descriptors for the attachment that was not deleted
      See Also:

    • ATTR_NOT_DELETED_ATTACHMENT_ERROR_DETAILS

      static final String ATTR_NOT_DELETED_ATTACHMENT_ERROR_DETAILS
      Name of the property in the result descriptors for the error details why an attachment was not deleted
      See Also:

    • ATTR_NOT_DELETED_ATTACHMENT_ERROR_MESSAGE

      static final String ATTR_NOT_DELETED_ATTACHMENT_ERROR_MESSAGE
      Name of the property in the result descriptors for the error message why an attachment was not deleted
      See Also:

  • Method Details

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