public interface InternalSearchRequest extends ManyReplyRequest, InternalAbandonableRequest
Modifier and Type | Field and Description |
---|---|
static MessageTypeEnum[] |
RESPONSE_TYPES
Different response types that a search request may return.
|
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(String attribute)
Adds an attribute to the set of entry attributes to return.
|
List<String> |
getAttributes()
Gets a list of the attributes to be returned from each entry which
matches the search filter.
|
DN |
getBase()
Gets the search base as a distinguished name.
|
AliasDerefMode |
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.
|
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.
|
void |
removeAttribute(String attribute)
Removes an attribute to the set of entry attributes to return.
|
void |
setBase(DN baseDn)
Sets the search base as a distinguished name.
|
void |
setDerefAliases(AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter.
|
void |
setFilter(ExprNode filter)
Sets the search filter associated with this search request.
|
void |
setScope(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.
|
getResultResponse
hasResponse
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
abandon, addAbandonListener, isAbandoned
static final MessageTypeEnum[] RESPONSE_TYPES
getResponseTypes()
MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface ManyReplyRequest
RESPONSE_TYPES
DN getBase()
void setBase(DN baseDn)
baseDn
- the search baseSearchScope getScope()
void setScope(SearchScope scope)
scope
- the scope enumeration parameter.AliasDerefMode getDerefAliases()
void setDerefAliases(AliasDerefMode aliasDerefAliases)
aliasDerefAliases
- the alias handling parameter enumeration.long getSizeLimit()
void setSizeLimit(long 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.List<String> getAttributes()
void addAttribute(String attribute)
attribute
- the attribute description or identifier.void removeAttribute(String attribute)
attribute
- the attribute description or identifier.Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.