|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.message.AbstractMessage
org.apache.directory.shared.ldap.message.AbstractRequest
org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
org.apache.directory.shared.ldap.message.SearchRequestImpl
Lockable SearchRequest implementation.
Field Summary |
Fields inherited from interface org.apache.directory.shared.ldap.message.SearchRequest |
RESPONSE_TYPES, TYPE |
Constructor Summary | |
SearchRequestImpl(int id)
Creates a Lockable SearcRequest implementing object used to search the DIT. |
Method Summary | |
void |
addAttribute(java.lang.String attribute)
Adds an attribute to the set of entry attributes to return. |
boolean |
equals(java.lang.Object obj)
Checks to see if two search requests are equal. |
java.util.Collection |
getAttributes()
Gets a list of the attributes to be returned from each entry which matches the search filter. |
java.lang.String |
getBase()
Gets the search base as a distinguished name. |
DerefAliasesEnum |
getDerefAliases()
Gets the alias handling parameter. |
ExprNode |
getFilter()
Gets the search filter associated with this search request. |
MessageTypeEnum[] |
getResponseTypes()
Gets the different response types generated by a search request. |
ResultResponse |
getResultResponse()
The result containing response for this request. |
ScopeEnum |
getScope()
Gets the search scope parameter enumeration. |
int |
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. |
void |
removeAttribute(java.lang.String attribute)
Removes an attribute to the set of entry attributes to return. |
void |
setBase(java.lang.String base)
Sets the search base as a distinguished name. |
void |
setDerefAliases(DerefAliasesEnum derefAliases)
Sets the alias handling parameter. |
void |
setFilter(ExprNode filter)
Sets the search filter associated with this search request. |
void |
setScope(ScopeEnum scope)
Sets the search scope parameter enumeration. |
void |
setSizeLimit(int 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. |
java.lang.String |
toString()
Return a string the represent a SearchRequest |
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractAbandonableRequest |
abandon, addAbandonListener, isAbandoned |
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractRequest |
hasResponse |
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractMessage |
add, get, getControls, getMessageId, getType, put, remove |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.directory.shared.ldap.message.Request |
hasResponse |
Methods inherited from interface org.apache.directory.shared.ldap.message.Message |
add, get, getControls, getMessageId, getType, put, remove |
Methods inherited from interface org.apache.directory.shared.ldap.message.AbandonableRequest |
abandon, addAbandonListener, isAbandoned |
Constructor Detail |
public SearchRequestImpl(int id)
id
- the sequential message identifierMethod Detail |
public java.util.Collection getAttributes()
getAttributes
in interface SearchRequest
public java.lang.String getBase()
getBase
in interface SearchRequest
public void setBase(java.lang.String base)
setBase
in interface SearchRequest
base
- the search basepublic DerefAliasesEnum getDerefAliases()
getDerefAliases
in interface SearchRequest
public void setDerefAliases(DerefAliasesEnum derefAliases)
setDerefAliases
in interface SearchRequest
derefAliases
- the alias handling parameter enumeration.public ExprNode getFilter()
getFilter
in interface SearchRequest
public void setFilter(ExprNode filter)
setFilter
in interface SearchRequest
filter
- the expression node for the root of the filter expression
tree.public MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface SearchRequest
RESPONSE_TYPES
public ScopeEnum getScope()
getScope
in interface SearchRequest
public void setScope(ScopeEnum scope)
setScope
in interface SearchRequest
scope
- the scope enumeration parameter.public int getSizeLimit()
getSizeLimit
in interface SearchRequest
public void setSizeLimit(int entriesMax)
setSizeLimit
in interface SearchRequest
entriesMax
- maximum search result entries to return.public int getTimeLimit()
getTimeLimit
in interface SearchRequest
public void setTimeLimit(int secondsMax)
setTimeLimit
in interface SearchRequest
secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
getTypesOnly
in interface SearchRequest
public void setTypesOnly(boolean typesOnly)
setTypesOnly
in interface SearchRequest
typesOnly
- true for only types, false for types and values.public void addAttribute(java.lang.String attribute)
addAttribute
in interface SearchRequest
attribute
- the attribute description or identifier.public void removeAttribute(java.lang.String attribute)
removeAttribute
in interface SearchRequest
attribute
- the attribute description or identifier.public ResultResponse getResultResponse()
getResultResponse
in interface ResultResponseRequest
public boolean equals(java.lang.Object obj)
equals
in class AbstractMessage
obj
- the object to check for equality to this SearchRequest
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |