Enum SearchBoxScopeType

  • All Implemented Interfaces:
    Serializable, Comparable<SearchBoxScopeType>

    public enum SearchBoxScopeType
    extends Enum<SearchBoxScopeType>

    Java class for SearchBoxScopeType.

    The following schema fragment specifies the expected content contained within this class.

     <simpleType name="SearchBoxScopeType">
       <restriction base="{http://www.w3.org/2001/XMLSchema}string">
         <enumeration value="oneLevel"/>
         <enumeration value="subtree"/>
       </restriction>
     </simpleType>
     
    • Enum Constant Detail

      • ONE_LEVEL

        public static final SearchBoxScopeType ONE_LEVEL
        Search will only traverse flat, one-level part of the hierarchy. This is ordinary search scope for non-hierarchical data. But when used in organizational hieraries, then this search scope will be limited only to a single organizational level.
      • SUBTREE

        public static final SearchBoxScopeType SUBTREE
        Search will traverse entire subtree. This scope makes no sense for non-hierarchical data. But when used in organizational hieraries, then this search scope will be span entire subtree with all sub-orgs.
    • Method Detail

      • values

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

        public static SearchBoxScopeType 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()