com.ibm.jarm.api.constants

Enum RMPrincipalSearchAttribute

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      DisplayName
      Specifies that the search pattern is applied against the display name attribute.
      None
      Specifies that no identifying attribute is used for the search pattern.
      ShortName
      Specifies that the search pattern is applied against the short name attribute.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static RMPrincipalSearchAttribute getInstanceFromInt(int intValue)
      Provides the RMPrincipalSearchAttribute instance that corresponds to the given int value.
      int getIntValue()
      Returns the integer value associated with this member.
      static RMPrincipalSearchAttribute valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RMPrincipalSearchAttribute[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

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

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

      • None

        public static final RMPrincipalSearchAttribute None
        Specifies that no identifying attribute is used for the search pattern.
      • ShortName

        public static final RMPrincipalSearchAttribute ShortName
        Specifies that the search pattern is applied against the short name attribute.
      • DisplayName

        public static final RMPrincipalSearchAttribute DisplayName
        Specifies that the search pattern is applied against the display name attribute.
    • Method Detail

      • values

        public static RMPrincipalSearchAttribute[] 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 (RMPrincipalSearchAttribute c : RMPrincipalSearchAttribute.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RMPrincipalSearchAttribute 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
      • getIntValue

        public int getIntValue()
        Returns the integer value associated with this member.
        Returns:
        An int value.
      • getInstanceFromInt

        public static RMPrincipalSearchAttribute getInstanceFromInt(int intValue)
        Provides the RMPrincipalSearchAttribute instance that corresponds to the given int value.
        Parameters:
        intValue - the int value to look up.
        Returns:
        A RMPrincipalSearchAttribute value or null if no such value corresponds to the given intValue parameter.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.