|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchRequest
Search request protocol message interface.
Field Summary | |
---|---|
static MessageTypeEnum[] |
RESPONSE_TYPES
Different response types that a search request may return. |
static MessageTypeEnum |
TYPE
Search request protocol message type |
Method Summary | |
---|---|
void |
addAttribute(String attribute)
Adds an attribute to the set of entry attributes to return. |
Collection |
getAttributes()
Gets a list of the attributes to be returned from each entry which matches the search filter. |
LdapDN |
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. |
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(String attribute)
Removes an attribute to the set of entry attributes to return. |
void |
setBase(LdapDN baseDn)
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. |
Methods inherited from interface org.apache.directory.shared.ldap.message.ResultResponseRequest |
---|
getResultResponse |
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 |
Field Detail |
---|
static final MessageTypeEnum TYPE
static final MessageTypeEnum[] RESPONSE_TYPES
getResponseTypes()
Method Detail |
---|
MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface ManyReplyRequest
RESPONSE_TYPES
LdapDN getBase()
void setBase(LdapDN baseDn)
baseDn
- the search baseScopeEnum getScope()
void setScope(ScopeEnum scope)
scope
- the scope enumeration parameter.DerefAliasesEnum getDerefAliases()
void setDerefAliases(DerefAliasesEnum derefAliases)
derefAliases
- the alias handling parameter enumeration.int getSizeLimit()
void setSizeLimit(int entriesMax)
entriesMax
- maximum search result entries to return.int getTimeLimit()
void setTimeLimit(int secondsMax)
secondsMax
- the search time limit in seconds.boolean getTypesOnly()
void setTypesOnly(boolean typesOnly)
typesOnly
- true for only types, false for types and values.ExprNode getFilter()
void setFilter(ExprNode filter)
filter
- the expression node for the root of the filter expression
tree.Collection getAttributes()
void addAttribute(String attribute)
attribute
- the attribute description or identifier.void removeAttribute(String attribute)
attribute
- the attribute description or identifier.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |