com.filenet.api.constants

Class SortOrder

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


    public final class SortOrder
    extends java.lang.Object
    implements java.io.Serializable
    Specifies the sort order.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static SortOrder ASCENDING
      Specifies that an ascending sort order will be used.
      static int ASCENDING_AS_INT
      An int value associated with the ASCENDING instance of this class.
      static SortOrder DESCENDING
      Specifies that a descending sort order will be used.
      static int DESCENDING_AS_INT
      An int value associated with the DESCENDING instance of this class.
      static SortOrder NONE
      Sort order is not specified.
      static int NONE_AS_INT
      An int value associated with the NONE instance of this class.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      static SortOrder 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

      • ASCENDING_AS_INT

        public static final int ASCENDING_AS_INT
        An int value associated with the ASCENDING 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
      • ASCENDING

        public static final SortOrder ASCENDING
        Specifies that an ascending sort order will be used.
      • DESCENDING_AS_INT

        public static final int DESCENDING_AS_INT
        An int value associated with the DESCENDING 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
      • DESCENDING

        public static final SortOrder DESCENDING
        Specifies that a descending sort order will be used.
      • NONE_AS_INT

        public static final int NONE_AS_INT
        An int value associated with the NONE 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
      • NONE

        public static final SortOrder NONE
        Sort order is not specified.
    • 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 SortOrder 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, 2019. All rights reserved.