org.apache.directory.shared.ldap.message
Class ScopeEnum

java.lang.Object
  extended byorg.apache.directory.shared.ldap.util.Enum
      extended byorg.apache.directory.shared.ldap.util.ValuedEnum
          extended byorg.apache.directory.shared.ldap.message.ScopeEnum
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable

public class ScopeEnum
extends ValuedEnum

Type-safe scope parameter enumeration.

Version:
$Revision: 379008 $
Author:
Alex Karasulu, $Author: akarasulu $
See Also:
Serialized Form

Field Summary
static ScopeEnum BASEOBJECT
          Search scope parameter enum for base object search
static int BASEOBJECT_LDAPVAL
          LDAP search scope parameter value for base object search
static int BASEOBJECT_VAL
          Search scope parameter value for base object search
static ScopeEnum SINGLELEVEL
          Search scope parameter enum for single level search
static int SINGLELEVEL_LDAPVAL
          LDAP search scope parameter value for single level search
static int SINGLELEVEL_VAL
          Search scope parameter value for single level search
static ScopeEnum WHOLESUBTREE
          Search scope parameter enum for whole subtree level search
static int WHOLESUBTREE_LDAPVAL
          LDAP search scope parameter value for whole subtree level search
static int WHOLESUBTREE_VAL
          Search scope parameter value for whole subtree level search
 
Fields inherited from class org.apache.directory.shared.ldap.util.Enum
iToString
 
Method Summary
 int getLdapValue()
          Gets the LdapValue for the scope enumeration as opposed to the JNDI value which is returned using getValue().
static ScopeEnum getScope(javax.naming.directory.SearchControls a_controls)
          Gets the type safe enumeration constant corresponding to a SearchControls scope value.
 
Methods inherited from class org.apache.directory.shared.ldap.util.ValuedEnum
compareTo, getEnum, getValue, toString
 
Methods inherited from class org.apache.directory.shared.ldap.util.Enum
equals, getEnum, getEnumClass, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BASEOBJECT_VAL

public static final int BASEOBJECT_VAL
Search scope parameter value for base object search

See Also:
Constant Field Values

SINGLELEVEL_VAL

public static final int SINGLELEVEL_VAL
Search scope parameter value for single level search

See Also:
Constant Field Values

WHOLESUBTREE_VAL

public static final int WHOLESUBTREE_VAL
Search scope parameter value for whole subtree level search

See Also:
Constant Field Values

BASEOBJECT_LDAPVAL

public static final int BASEOBJECT_LDAPVAL
LDAP search scope parameter value for base object search

See Also:
Constant Field Values

SINGLELEVEL_LDAPVAL

public static final int SINGLELEVEL_LDAPVAL
LDAP search scope parameter value for single level search

See Also:
Constant Field Values

WHOLESUBTREE_LDAPVAL

public static final int WHOLESUBTREE_LDAPVAL
LDAP search scope parameter value for whole subtree level search

See Also:
Constant Field Values

BASEOBJECT

public static final ScopeEnum BASEOBJECT
Search scope parameter enum for base object search


SINGLELEVEL

public static final ScopeEnum SINGLELEVEL
Search scope parameter enum for single level search


WHOLESUBTREE

public static final ScopeEnum WHOLESUBTREE
Search scope parameter enum for whole subtree level search

Method Detail

getScope

public static ScopeEnum getScope(javax.naming.directory.SearchControls a_controls)
Gets the type safe enumeration constant corresponding to a SearchControls scope value.

Parameters:
a_controls - the SearchControls whose scope value we convert to enum
Returns:
the SopeEnum for the scope int value

getLdapValue

public int getLdapValue()
Gets the LdapValue for the scope enumeration as opposed to the JNDI value which is returned using getValue().

Returns:
the LDAP enumeration value for the scope parameter on a search request.


Copyright © 2003-2006 . All Rights Reserved.