com.sapportals.portal.pcd.gl

Class PcdSearchControls

java.lang.Object

javax.naming.directory.SearchControls

com.sapportals.portal.pcd.gl.PcdSearchControls

All Implemented Interfaces:

Serializable

public class PcdSearchControls
extends SearchControls

Pcd-specific extension of javax.naming.directory.SearchControls. This class defines additional SearchScopes and allows to specify a Locale and a skip condition. By default, it sets the returningAttributes to an empty String array, indicating that no attributes are to be returned.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SUBTREE_ONLY_SCOPE Search the subtree of the named context but do not include the start node itself.
static int	SUBTREE_WITH_UNIT_ROOTS_SCOPE Search the subtree of the named context but don't go into units.
static int	SUBTREE_WITHOUT_UNITS_SCOPE Search the subtree of the named context but ignore all unit roots and unit internal objects.
static int	UNIT_ROOTS_ONLY_SCOPE Search the subtree of the named context, including unit roots, but don't look at inner parts of units.
static int	UPWARDS_TO_UNIT_ROOT_SCOPE Search all nodes from the named context upwards(!)

Fields inherited from class javax.naming.directory.SearchControls

OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE

Constructor Summary

Constructors

Constructor and Description
PcdSearchControls() Initializes the returning attributes with an empty String array, thus indicating that by default no attributes should be returned.
PcdSearchControls(PcdSearchControls controls) Constructs a new search constraints using arguments.
PcdSearchControls(SearchControls controls) Constructs a new search constraints using arguments.

Method Summary

Modifier and Type	Method and Description
boolean	getDoPhysicalTreeTraversal()
Locale	getLocale()
static String	getScopeDescription(int scope) Returns search control scope description
String	getSkipCondition() Returns the skipCondition.
static boolean	isScopeValid(int aScope) Returns true if scope is valid
void	setDoPhysicalTreeTraversal(boolean doPhysicalTreeTraversal) Enables, for very specialized searches, to browse through the physical representation of deltalinks, rather than through their virtual tree.
void	setLocale(Locale aLocale) Specify a locale that is to be used when comparing text attributes.
void	setSkipCondition(String skipCondition) Sets the skip condition.

Methods inherited from class javax.naming.directory.SearchControls

getCountLimit, getDerefLinkFlag, getReturningAttributes, getReturningObjFlag, getSearchScope, getTimeLimit, setCountLimit, setDerefLinkFlag, setReturningAttributes, setReturningObjFlag, setSearchScope, setTimeLimit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTREE_WITH_UNIT_ROOTS_SCOPE

public static final int SUBTREE_WITH_UNIT_ROOTS_SCOPE

Search the subtree of the named context but don't go into units.

The search will not cross naming system boundaries.

The NamingEnumeration that results from search() using SUBTREE_WITH_UNIT_ROOTS_SCOPE contains elements with objects in the named context's subtree (including the named context) that satisfy the search filter specified in search() and that are not unit-internal nodes. The names of elements in the NamingEnumeration are relative to the named context.

The value of this constant is 3.

See Also:

Constant Field Values

UNIT_ROOTS_ONLY_SCOPE

public static final int UNIT_ROOTS_ONLY_SCOPE

Search the subtree of the named context, including unit roots, but don't look at inner parts of units.

The NamingEnumeration that results from search() using UNIT_ROOTS_ONLY_SCOPE contains elements with objects in the named context's subtree (including the named context) that satisfy the search filter specified in search() and that are unit root nodes. The names of elements in the NamingEnumeration are relative to the named context.

The value of this constant is 4.

See Also:

Constant Field Values

SUBTREE_WITHOUT_UNITS_SCOPE

public static final int SUBTREE_WITHOUT_UNITS_SCOPE

Search the subtree of the named context but ignore all unit roots and unit internal objects.

The NamingEnumeration that results from search() using SUBTREE_WITHOUT_UNITS_SCOPE contains elements with objects in the named context's subtree (including the named context) that satisfy the search filter specified in search() and that are not unit root nodes and not unit internal nodes. The names of elements in the NamingEnumeration are relative to the named context.

The value of this constant is 5.

See Also:

Constant Field Values

SUBTREE_ONLY_SCOPE

public static final int SUBTREE_ONLY_SCOPE

Search the subtree of the named context but do not include the start node itself.

The NamingEnumeration that results from search() using SUBTREE_ONLY_SCOPE contains elements with objects in the named context's subtree that satisfy the search filter specified in search(). This is the same as with SUBTREE_SCOPE, except that the start node of the search is not included. The names of elements in the NamingEnumeration are relative to the named context.

The value of this constant is 6.

See Also:

Constant Field Values

UPWARDS_TO_UNIT_ROOT_SCOPE

public static final int UPWARDS_TO_UNIT_ROOT_SCOPE

Search all nodes from the named context upwards(!) to the root node of the unit. If the named context is not part of a unit, then an empty search result is returned.

The names of elements in the NamingEnumeration are absolute names. The sequence of the objects in the result set corresponds to the search sequence: children first, parents last.

The value of this constant is 7.

See Also:

Constant Field Values

Constructor Detail

PcdSearchControls

public PcdSearchControls()

Initializes the returning attributes with an empty String array, thus indicating that by default no attributes should be returned.

PcdSearchControls

public PcdSearchControls(SearchControls controls)

Constructs a new search constraints using arguments.

Parameters:

controls - SearchControls

PcdSearchControls

public PcdSearchControls(PcdSearchControls controls)

Constructs a new search constraints using arguments.

Parameters:

controls - SearchControls

Method Detail

isScopeValid

public static final boolean isScopeValid(int aScope)

Returns true if scope is valid

Parameters:

aScope - search control scope id

Returns:

boolean true if scope is valid

getScopeDescription

public static String getScopeDescription(int scope)

Returns search control scope description

Parameters:

scope - search control scope id

Returns:

String search control scope description

setLocale

public void setLocale(Locale aLocale)

Specify a locale that is to be used when comparing text attributes.

Parameters:

aLocale - the locale to be used

getLocale

public Locale getLocale()

Returns:

Locale

See Also:

setLocale(java.util.Locale)

getSkipCondition

public String getSkipCondition()

Returns the skipCondition.

Returns:

String

setSkipCondition

public void setSkipCondition(String skipCondition)

Sets the skip condition. The skip condition is used in hierarchical searches to exclude subtrees from the search run. If a skip condition is present, then each node is checked if it matches this skip condition. If it does, the subtree of the node is excluded from the search and the search is continued with the remaining tree. A node that matches the searchCondition and the skip condition, will be added to the search result, but none of its children will be examined. Setting a skipCondition always prevents using the database search.

Parameters:

skipCondition - The skipCondition to set; it uses the same syntax as the filterExpression (RFC 2254)

getDoPhysicalTreeTraversal

public boolean getDoPhysicalTreeTraversal()

Returns:

by default, false

See Also:

setDoPhysicalTreeTraversal(boolean)

setDoPhysicalTreeTraversal

public void setDoPhysicalTreeTraversal(boolean doPhysicalTreeTraversal)

Enables, for very specialized searches, to browse through the physical representation of deltalinks, rather than through their virtual tree.

Parameters:

doPhysicalTreeTraversal - if true browse through the physical representation of deltalinks