Enum ProcessingResultCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ProcessingResultCode>

    public enum ProcessingResultCode
    extends java.lang.Enum<ProcessingResultCode>
    Represents the result of processing a message or document. SDK replacement for api model class ProcessingResultCode
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COMPLETED
      Indicates that a message reached the end of it's workflow.
      CREATED
      Created by the component
      DROP
      Successfully processed the message, but did not pass it on to the next stage.
      FAIL
      Document failed.
      FOUND
      Correction for a document or message incorrectly marked as LOST
      LOST
      Indicates that a message/document has been lost and will not be completed/dropped.
      NOT_HANDLED
      Not handled by this component.
      OK
      Successfully processed the message.
      RECEIVED
      Indicates a message or document was received from a remote node
      REFEED
      Indicates that a message/document has been re-fed
      WARN
      Indicates that a stage had a warning about a document but did not fail the document.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ProcessingResultCode fromExternal​(java.lang.String value)
      Converts an external value to a ProcessingResultCode value.
      static ProcessingResultCode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ProcessingResultCode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NOT_HANDLED

        public static final ProcessingResultCode NOT_HANDLED
        Not handled by this component. This should only be used by services for callback purposes.
      • REFEED

        public static final ProcessingResultCode REFEED
        Indicates that a message/document has been re-fed
      • FOUND

        public static final ProcessingResultCode FOUND
        Correction for a document or message incorrectly marked as LOST
      • RECEIVED

        public static final ProcessingResultCode RECEIVED
        Indicates a message or document was received from a remote node
      • WARN

        public static final ProcessingResultCode WARN
        Indicates that a stage had a warning about a document but did not fail the document.
      • DROP

        public static final ProcessingResultCode DROP
        Successfully processed the message, but did not pass it on to the next stage.
      • COMPLETED

        public static final ProcessingResultCode COMPLETED
        Indicates that a message reached the end of it's workflow. This should only be used by internal system components.
      • FAIL

        public static final ProcessingResultCode FAIL
        Document failed. this should only be used by services for callback purposes.
      • LOST

        public static final ProcessingResultCode LOST
        Indicates that a message/document has been lost and will not be completed/dropped.
    • Method Detail

      • values

        public static ProcessingResultCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ProcessingResultCode c : ProcessingResultCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ProcessingResultCode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • fromExternal

        public static ProcessingResultCode fromExternal​(java.lang.String value)
        Converts an external value to a ProcessingResultCode value.
        Parameters:
        value - the external value
        Returns:
        the type