Enum SearchHierarchyScopeType

  • All Implemented Interfaces:
    Serializable, Comparable<SearchHierarchyScopeType>

    public enum SearchHierarchyScopeType
    extends Enum<SearchHierarchyScopeType>
    Definition of search hierarchy scope. It specifies how "deep" the search should go into the object hierarchy. It is only applicable to resources that support hierarchical organization of objects (e.g. LDAP resources).
    • Enum Constant Detail

      • SUB

        public static final SearchHierarchyScopeType SUB
        Subtree search. The search go deep down the hierarchy, as deep as possible.
      • ONE

        public static final SearchHierarchyScopeType ONE
        One-level search. The search is reaching just one level below the base context object.
    • Method Detail

      • values

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

        public static SearchHierarchyScopeType valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • value

        public String value()