|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface SearchRequest
This interface defines a set of methods which may be used to interact with a search request.
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getAttributes()
Retrieves the list of requested attributes. |
java.lang.String |
getBaseDN()
Retrieves the base DN for the search. |
com.unboundid.ldap.sdk.DereferencePolicy |
getDerefPolicy()
Retrieves the dereference policy for the search. |
com.unboundid.ldap.sdk.Filter |
getFilter()
Retrieves the filter for the search. |
com.unboundid.ldap.sdk.SearchScope |
getScope()
Retrieves the scope for the search. |
int |
getSizeLimit()
Retrieves the size limit for the search. |
int |
getTimeLimitSeconds()
Retrieves the time limit for the search in seconds. |
boolean |
getTypesOnly()
Indicates whether search result entries should contain only attribute types or both types and values. |
com.unboundid.ldap.sdk.ReadOnlySearchRequest |
toLDAPSDKRequest(com.unboundid.ldap.sdk.SearchResultListener listener)
Retrieves an LDAP SDK representation of this search request. |
Methods inherited from interface com.unboundid.directory.sdk.common.operation.Request |
---|
getOperationType, getRequestControls |
Method Detail |
---|
java.lang.String getBaseDN()
com.unboundid.ldap.sdk.SearchScope getScope()
com.unboundid.ldap.sdk.DereferencePolicy getDerefPolicy()
int getSizeLimit()
int getTimeLimitSeconds()
boolean getTypesOnly()
true
if search result entries should contain only
attribute types but no values, or false
if entries should
contain both attribute types and values.com.unboundid.ldap.sdk.Filter getFilter()
java.util.List<java.lang.String> getAttributes()
com.unboundid.ldap.sdk.ReadOnlySearchRequest toLDAPSDKRequest(com.unboundid.ldap.sdk.SearchResultListener listener)
listener
- The search result listener that should be used for the
request. It may be null
if no listener should be
used.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |