|
Sun Adapter for LDAP API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.stc.connector.ldapadapter.appconn.SearchOptionsImpl
public class SearchOptionsImpl
This class is used to set the options for the search operation
| Field Summary |
|---|
| Fields inherited from interface com.stc.connector.appconn.ldap.SearchOptions |
|---|
OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE |
| Constructor Summary | |
|---|---|
protected |
SearchOptionsImpl()
|
| Method Summary | |
|---|---|
AttributesSelection |
getAttributesSelection()
Method to retrieve the value of the 'list of attributes' that has been set as attributes to return by the search operation |
java.lang.String |
getContextName()
Returns the name of the context for the search. |
int |
getCountLimit()
Gets the size limitation on the search results for the search operation. |
boolean |
getReturningObjFlag()
Gets the boolean flag to determine whether objects will be returned as part of the result. |
java.lang.String |
getSearchFilter()
Gets the search filter for the search. |
int |
getSearchScope()
Gets the search scope for the search. |
int |
getTimeLimit()
Gets the timeout in milliseconds for the search operation. |
void |
reset()
Method to reset the values |
void |
setContextName(java.lang.String contextName)
Sets the name of the context for the search (where to start searching). |
void |
setCountLimit(int countLimit)
Sets the size limitation on the search results for the search operation. |
void |
setReturningObjFlag(boolean returnObjFlag)
Sets the boolean flag to enable/disable returning objects returned as part of the result. |
void |
setSearchFilter(java.lang.String filter)
Sets the search filter for the search. |
void |
setSearchScope(int scope)
Sets the search scope for the search. |
void |
setTimeLimit(int timeLimitMilliSec)
Sets the timeout in milliseconds for the search operation. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected SearchOptionsImpl()
| Method Detail |
|---|
public void reset()
SearchOptions
reset in interface SearchOptionspublic AttributesSelection getAttributesSelection()
getAttributesSelection in interface SearchOptionspublic void setContextName(java.lang.String contextName)
setContextName in interface SearchOptionsname - The name of the context for the search.public java.lang.String getContextName()
getContextName in interface SearchOptionspublic void setSearchScope(int scope)
setSearchScope in interface SearchOptionsscope - The scope of the directory search.
Valid values are OBJECT_SCOPE, ONELEVEL_SCOPE, or SUBTREE_SCOPE.SearchOptions.OBJECT_SCOPE,
SearchOptions.ONELEVEL_SCOPE,
SearchOptions.SUBTREE_SCOPEpublic int getSearchScope()
getSearchScope in interface SearchOptionspublic void setSearchFilter(java.lang.String filter)
setSearchFilter in interface SearchOptionsfilter - The filter expression to use for the search;
may not be null. For example, for LDAP, see
RFC 2254.public java.lang.String getSearchFilter()
getSearchFilter in interface SearchOptionspublic void setTimeLimit(int timeLimitMilliSec)
setTimeLimit in interface SearchOptionstimeLimitMilliSec - The timeout value in milliseconds.
If 0 is specified, then the search will wait indefinitely; this is the default.public int getTimeLimit()
getTimeLimit in interface SearchOptionspublic void setCountLimit(int countLimit)
setCountLimit in interface SearchOptionscountLimit - The maximum number of results returned for the search.
If 0 is specified, then return all results if there are any results; this is the defaultpublic int getCountLimit()
getCountLimit in interface SearchOptionspublic void setReturningObjFlag(boolean returnObjFlag)
setReturningObjFlag in interface SearchOptionsreturnObjFlag - true to return objects in result.
false to return only name and class of objects in result.public boolean getReturningObjFlag()
getReturningObjFlag in interface SearchOptions
|
Sun Adapter for LDAP API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||