org.opends.server.admin.std.meta
Enum LocalDBVLVIndexCfgDefn.Scope

java.lang.Object
  extended by java.lang.Enum<LocalDBVLVIndexCfgDefn.Scope>
      extended by org.opends.server.admin.std.meta.LocalDBVLVIndexCfgDefn.Scope
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<LocalDBVLVIndexCfgDefn.Scope>
Enclosing class:
LocalDBVLVIndexCfgDefn

public static enum LocalDBVLVIndexCfgDefn.Scope
extends java.lang.Enum<LocalDBVLVIndexCfgDefn.Scope>

Defines the set of permissable values for the "scope" property.

Specifies the LDAP scope of the query that is being indexed.


Enum Constant Summary
BASE_OBJECT
          Search the base object only.
SINGLE_LEVEL
          Search the immediate children of the base object but do not include any of their descendants or the base object itself.
SUBORDINATE_SUBTREE
          Search the entire subtree below the base object but do not include the base object itself.
WHOLE_SUBTREE
          Search the base object and the entire subtree below the base object.
 
Method Summary
 java.lang.String toString()
          
static LocalDBVLVIndexCfgDefn.Scope valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static LocalDBVLVIndexCfgDefn.Scope[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BASE_OBJECT

public static final LocalDBVLVIndexCfgDefn.Scope BASE_OBJECT
Search the base object only.


SINGLE_LEVEL

public static final LocalDBVLVIndexCfgDefn.Scope SINGLE_LEVEL
Search the immediate children of the base object but do not include any of their descendants or the base object itself.


SUBORDINATE_SUBTREE

public static final LocalDBVLVIndexCfgDefn.Scope SUBORDINATE_SUBTREE
Search the entire subtree below the base object but do not include the base object itself.


WHOLE_SUBTREE

public static final LocalDBVLVIndexCfgDefn.Scope WHOLE_SUBTREE
Search the base object and the entire subtree below the base object.

Method Detail

values

public static LocalDBVLVIndexCfgDefn.Scope[] 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 (LocalDBVLVIndexCfgDefn.Scope c : LocalDBVLVIndexCfgDefn.Scope.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static LocalDBVLVIndexCfgDefn.Scope 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

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<LocalDBVLVIndexCfgDefn.Scope>