Package de.xima.fc.workflow.retval.node

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_ATTACHMENT_FILE

      static final String ATTR_ATTACHMENT_FILE
      Name of the property in the result descriptor for an attachment's file.
      See Also:

    • ATTR_ATTACHMENT_FILE_NAME

      static final String ATTR_ATTACHMENT_FILE_NAME
      Name of the property in the result descriptor for an attachment's file name.
      See Also:

    • ATTR_ATTACHMENT_SOURCE

      static final String ATTR_ATTACHMENT_SOURCE
      Name of the property in the result descriptor for an attachment's source type.
      See Also:

    • ATTR_ATTACHMENT_UUID

      static final String ATTR_ATTACHMENT_UUID
      Name of the property in the result descriptor for an attachment's UUID.
      See Also:

    • 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

    • getErrorValueDescriptor

      default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory f)
      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:
      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).

    • getSoftErrorValueDescriptor

      default IUnionValueDescriptor<String> getSoftErrorValueDescriptor(IValueDescriptorFactory f)
      Description copied from interface: IExecutionResultDescriptor
      The union descriptor 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. 
       factory.recordBuilder() //
     .requiredProperty("errorCode", factory.integer()) //
     .requiredProperty("errorMessage", factory.string()) //
     .requiredProperty("localizedMessage", factory.integer());
 return factory.add("MISSING_UPLOAD", error) //
     .add("CLIENT_ERROR", error);
      The example above uses the same data type for each error, but you can return different data depending on the error type.

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

      Specified by:
      getSoftErrorValueDescriptor 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)
      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 value descriptor for that data that is made available to the workflow when the node is executed successfully.