com.sas.edir
Class EnterpriseDirectorySearchConstraint

java.lang.Object
  |
  +--com.sas.edir.EnterpriseDirectorySearchConstraint

public class EnterpriseDirectorySearchConstraint

extends java.lang.Object

Field Summary

static int	SCOPE_BASE Scope which applies only to base DN.
static int	SCOPE_ONELEVEL Scope which limits search to one level below base.
static int	SCOPE_SUBTREE Scope which searches an entire subtree below the base DN.

Constructor Summary

EnterpriseDirectorySearchConstraint()

EnterpriseDirectorySearchConstraint(int sizeLimit, int timeLimit, int scope, java.lang.String[] attributes, boolean refFlag)

Method Summary

boolean	getReferralFlag() Get the referral chase flag.
java.lang.String[]	getReturnedAttributes() Get the attributes to return in the results.
int	getSearchScope() Get the scope of the search
int	getSizeLimit() Get the sizelimit.
int	getTimeLimit() Get the timelimit.
void	setReferralFlag(boolean refFlag) Set whether to chase referrals
void	setReturnedAttributes(java.lang.String[] retAttrs) Set the attributes to return in the results.
void	setSearchScope(int scope) Set the scope of the search
void	setSizeLimit(int sizeLimit) Set the number of results to allow
void	setTimeLimit(int timeLimit) Set the time limit in milliseconds.

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_BASE

public static final int SCOPE_BASE

Scope which applies only to base DN.

SCOPE_ONELEVEL

public static final int SCOPE_ONELEVEL

Scope which limits search to one level below base.

SCOPE_SUBTREE

public static final int SCOPE_SUBTREE

Scope which searches an entire subtree below the base DN.

Constructor Detail

EnterpriseDirectorySearchConstraint

public EnterpriseDirectorySearchConstraint(int sizeLimit,
                                           int timeLimit,
                                           int scope,
                                           java.lang.String[] attributes,
                                           boolean refFlag)

EnterpriseDirectorySearchConstraint

public EnterpriseDirectorySearchConstraint()

Method Detail

setSizeLimit

public void setSizeLimit(int sizeLimit)

Set the number of results to allow

Parameters:

sizeLimit - Size limit

getSizeLimit

public int getSizeLimit()

Get the sizelimit.

Returns:

The sizelimit

setTimeLimit

public void setTimeLimit(int timeLimit)

Set the time limit in milliseconds.

Parameters:

timeLimit - The time to wait for a response in milliseconds.

getTimeLimit

public int getTimeLimit()

Get the timelimit.

Returns:

The timelimit.

setReturnedAttributes

public void setReturnedAttributes(java.lang.String[] retAttrs)

Set the attributes to return in the results.

Parameters:

retAttrs - An array of strings containing the attribute names to return.

getReturnedAttributes

public java.lang.String[] getReturnedAttributes()

Get the attributes to return in the results.

Returns:

The array of attribute types to return.

setSearchScope

public void setSearchScope(int scope)

Set the scope of the search

Parameters:

scope - The scope of the search to perform.

getSearchScope

public int getSearchScope()

Get the scope of the search

Returns:

The search scope.

setReferralFlag

public void setReferralFlag(boolean refFlag)

Set whether to chase referrals

Parameters:

refFlag - True to chase referrals.

getReferralFlag

public boolean getReferralFlag()

Get the referral chase flag.

Returns:

The referral flag.