com.filenet.api.constants

Class PrincipalSearchAttribute

  • java.lang.Object
    • com.filenet.api.constants.PrincipalSearchAttribute
    • Method Summary

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

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

      • NONE_AS_INT

        public static final int NONE_AS_INT
        An integer associated with the NONE instance of this class.

        Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.

        See Also:
        Constant Field Values
      • SHORT_NAME_AS_INT

        public static final int SHORT_NAME_AS_INT
        An integer associated with the SHORT_NAME instance of this class.

        Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.

        See Also:
        Constant Field Values
      • DISPLAY_NAME_AS_INT

        public static final int DISPLAY_NAME_AS_INT
        An integer associated with the DISPLAY_NAME instance of this class.

        Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.

        See Also:
        Constant Field Values
    • Method Detail

      • getValue

        public int getValue()
        Returns an integer value associated with a specific instance of this class.
        Returns:
        An integer representing a specific instance of this class.
      • getInstanceFromInt

        public static PrincipalSearchAttribute getInstanceFromInt(int value)
        Gets the instance of this class using its associated integer value (the *_AS_INT fields).
        Parameters:
        value - An integer representing a particular static instance of this class.
        Returns:
        The PrincipalSearchAttribute instance referenced.
        Throws:
        EngineRuntimeException - Thrown when the parameter is null or invalid.
      • toString

        public java.lang.String toString()
        Returns a String representation of this instance.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A String representing the instance.

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