com.filenet.api.constants

Class QueueEntryStatus

  • java.lang.Object
    • com.filenet.api.constants.QueueEntryStatus
  • All Implemented Interfaces:
    java.io.Serializable


    public final class QueueEntryStatus
    extends java.lang.Object
    implements java.io.Serializable
    Provides a set of read-only constants that specify the status of the queue-related operation. There is no constant that indicates a completion state. When an operation completes successfully, the item is removed from the queue.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static QueueEntryStatus FAILED
      Indicates that the operation failed on the queue item.
      static int FAILED_AS_INT
      An int value associated with the FAILED instance of this class.
      static QueueEntryStatus IN_PROGRESS
      Indicates that the operation is in progress.
      static int IN_PROGRESS_AS_INT
      An int value associated with the IN_PROGRESS instance of this class.
      static QueueEntryStatus RETRY_WAIT
      Indicates that the operation failed and is being retried on the queue item.
      static int RETRY_WAIT_AS_INT
      An int value associated with the RETRY_WAIT instance of this class.
      static QueueEntryStatus WAITING
      Indicates that the operation has not started on the queue item.
      static int WAITING_AS_INT
      An int value associated with the WAITING instance of this class.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static QueueEntryStatus getInstanceFromInt(int value)
      Returns an instance of this class using its associated integer value.
      int getValue()
      Returns the internal integer value associated with a specific instance of this class.
      java.lang.String toString()
      Returns a String representation of this enumeration instance.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • WAITING_AS_INT

        public static final int WAITING_AS_INT
        An int value associated with the WAITING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • WAITING

        public static final QueueEntryStatus WAITING
        Indicates that the operation has not started on the queue item.
      • FAILED_AS_INT

        public static final int FAILED_AS_INT
        An int value associated with the FAILED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • FAILED

        public static final QueueEntryStatus FAILED
        Indicates that the operation failed on the queue item.
      • RETRY_WAIT_AS_INT

        public static final int RETRY_WAIT_AS_INT
        An int value associated with the RETRY_WAIT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • RETRY_WAIT

        public static final QueueEntryStatus RETRY_WAIT
        Indicates that the operation failed and is being retried on the queue item.
      • IN_PROGRESS_AS_INT

        public static final int IN_PROGRESS_AS_INT
        An int value associated with the IN_PROGRESS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • IN_PROGRESS

        public static final QueueEntryStatus IN_PROGRESS
        Indicates that the operation is in progress.
    • Method Detail

      • getValue

        public int getValue()
        Returns the internal integer value associated with a specific instance of this class.
        Returns:
        The enumeration instance's ordinal value.
        See Also:
        getInstanceFromInt(int)
      • toString

        public java.lang.String toString()
        Returns a String representation of this enumeration instance.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The enumeration instance's description.
      • getInstanceFromInt

        public static QueueEntryStatus getInstanceFromInt(int value)
        Returns an instance of this class using its associated integer value.
        Parameters:
        value - The integer value. (See the *_AS_INT fields.)
        Returns:
        The enumeration instance with the given ordinal value.
        Throws:
        EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
        See Also:
        getValue()

© Copyright IBM Corporation 2006, 2013. All rights reserved.