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

Interface IFcExportToXmlDescriptors

    • Method Detail

      • getAttachmentAndFileDescriptorI18nPrefix

        default String getAttachmentAndFileDescriptorI18nPrefix()

      • 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 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.

      • 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.