|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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(java.lang.String a_attribute)
Adds an attribute to the set of entry attributes to return. |
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. |
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 a_attribute)
Removes an attribute to the set of entry attributes to return. |
void |
setBase(java.lang.String a_baseDn)
Sets the search base as a distinguished name. |
void |
setDerefAliases(DerefAliasesEnum a_derefAliases)
Sets the alias handling parameter. |
void |
setFilter(ExprNode a_filter)
Sets the search filter associated with this search request. |
void |
setScope(ScopeEnum a_scope)
Sets the search scope parameter enumeration. |
void |
setSizeLimit(int a_entriesMax)
Sets sizelimit that restricts the maximum number of entries to be returned as a result of the search. |
void |
setTimeLimit(int a_secondsMax)
Sets the timelimit that restricts the maximum time (in seconds) allowed for a search. |
void |
setTypesOnly(boolean a_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 |
public static final MessageTypeEnum TYPE
public static final MessageTypeEnum[] RESPONSE_TYPES
getResponseTypes()
Method Detail |
public MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface ManyReplyRequest
RESPONSE_TYPES
public java.lang.String getBase()
public void setBase(java.lang.String a_baseDn)
a_baseDn
- the search basepublic ScopeEnum getScope()
public void setScope(ScopeEnum a_scope)
a_scope
- the scope enumeration parameter.public DerefAliasesEnum getDerefAliases()
public void setDerefAliases(DerefAliasesEnum a_derefAliases)
a_derefAliases
- the alias handling parameter enumeration.public int getSizeLimit()
public void setSizeLimit(int a_entriesMax)
a_entriesMax
- maximum search result entries to return.public int getTimeLimit()
public void setTimeLimit(int a_secondsMax)
a_secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
public void setTypesOnly(boolean a_typesOnly)
a_typesOnly
- true for only types, false for types and values.public ExprNode getFilter()
public void setFilter(ExprNode a_filter)
a_filter
- the expression node for the root of the filter expression
tree.public java.util.Collection getAttributes()
public void addAttribute(java.lang.String a_attribute)
a_attribute
- the attribute description or identifier.public void removeAttribute(java.lang.String a_attribute)
a_attribute
- the attribute description or identifier.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |