|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.ldap.client.api.message.AbstractMessage
org.apache.directory.ldap.client.api.message.AbstractRequest
org.apache.directory.ldap.client.api.message.SearchRequest
public class SearchRequest
Search request protocol message interface.
Constructor Summary | |
---|---|
SearchRequest()
Creates a new instance of SearchRequestImpl. |
Method Summary | |
---|---|
SearchRequest |
addAttributes(java.lang.String... attributes)
Adds attributes to the set of entry attributes to return. |
java.util.Set<java.lang.String> |
getAttributes()
Gets a list of the attributes to be returned from each entry which matches the search filter. |
java.lang.String |
getBaseDn()
Gets the search base as a distinguished name. |
org.apache.directory.shared.ldap.message.AliasDerefMode |
getDerefAliases()
Gets the alias handling parameter. |
java.lang.String |
getFilter()
Gets the search filter associated with this search request. |
org.apache.directory.shared.ldap.filter.SearchScope |
getScope()
Gets the search scope parameter enumeration. |
long |
getSizeLimit()
A sizelimit that restricts the maximum number of entries to be returned as a result of the search. |
int |
getTimeLimit()
Gets the timelimit that restricts the maximum time (in seconds) allowed for a search. |
boolean |
getTypesOnly()
An indicator as to whether search results will contain both attribute types and values, or just attribute types. |
SearchRequest |
removeAttributes(java.lang.String... attributes)
Removes attributes to the set of entry attributes to return. |
void |
setBaseDn(java.lang.String baseDn)
Sets the search base as a distinguished name. |
void |
setDerefAliases(org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter. |
void |
setFilter(java.lang.String filter)
Sets the search filter associated with this search request. |
void |
setScope(org.apache.directory.shared.ldap.filter.SearchScope scope)
Sets the search scope parameter enumeration. |
void |
setSizeLimit(long entriesMax)
Sets sizelimit that restricts the maximum number of entries to be returned as a result of the search. |
void |
setTimeLimit(int secondsMax)
Sets the timelimit that restricts the maximum time (in seconds) allowed for a search. |
void |
setTypesOnly(boolean typesOnly)
An indicator as to whether search results will contain both attribute types and values, or just attribute types. |
Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractRequest |
---|
getTimeout, setTimeout |
Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractMessage |
---|
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.directory.ldap.client.api.message.Request |
---|
getTimeout, setTimeout |
Methods inherited from interface org.apache.directory.ldap.client.api.message.Message |
---|
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId |
Constructor Detail |
---|
public SearchRequest()
messageId
- The message IDMethod Detail |
---|
public java.util.Set<java.lang.String> getAttributes()
public java.lang.String getBaseDn()
public void setBaseDn(java.lang.String baseDn)
baseDn
- the search basepublic org.apache.directory.shared.ldap.message.AliasDerefMode getDerefAliases()
public void setDerefAliases(org.apache.directory.shared.ldap.message.AliasDerefMode aliasDerefAliases)
aliasDerefAliases
- the alias handling parameter enumeration.public java.lang.String getFilter()
public void setFilter(java.lang.String filter)
filter
- the expression node for the root of the filter
expression tree.public org.apache.directory.shared.ldap.filter.SearchScope getScope()
public void setScope(org.apache.directory.shared.ldap.filter.SearchScope scope)
scope
- the scope enumeration parameter.public long getSizeLimit()
public void setSizeLimit(long entriesMax)
entriesMax
- maximum search result entries to return.public int getTimeLimit()
public void setTimeLimit(int secondsMax)
secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
public void setTypesOnly(boolean typesOnly)
typesOnly
- true for only types, false for types and values.public SearchRequest addAttributes(java.lang.String... attributes)
attributes
- the attributes description or identifier.
public SearchRequest removeAttributes(java.lang.String... attributes)
attributes
- the attributes description or identifier.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |