Interface InProgressSearchOperation
-
- All Superinterfaces:
InProgressOperation
,PluginOperation
- All Known Implementing Classes:
SearchOperation
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface InProgressSearchOperation extends InProgressOperation
This class defines a set of methods that are available for use by in progress search plugins. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Set<String>
getAttributes()
Retrieves the set of requested attributes for this search operation.Dn
getBaseDN()
Retrieves the base DN for this search operation.DereferenceAliasesPolicy
getDerefPolicy()
Retrieves the alias dereferencing policy for this search operation.Filter
getFilter()
Retrieves the filter for this search operation.SearchScope
getScope()
Retrieves the scope for this search operation.int
getSizeLimit()
Retrieves the size limit for this search operation.int
getTimeLimit()
Retrieves the time limit for this search operation.boolean
getTypesOnly()
Retrieves the typesOnly flag for this search operation.-
Methods inherited from interface org.opends.server.types.operation.InProgressOperation
addAdditionalLogItem, addResponseControl, appendErrorMessage, getAdditionalLogItems, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setErrorMessage, setMatchedDN, setReferralURLs, setResult, setResultCode
-
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getRequestControl, getRequestControl, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
-
-
-
-
Method Detail
-
getBaseDN
Dn getBaseDN()
Retrieves the base DN for this search operation.- Returns:
- The base DN for this search operation.
-
getScope
SearchScope getScope()
Retrieves the scope for this search operation.- Returns:
- The scope for this search operation.
-
getDerefPolicy
DereferenceAliasesPolicy getDerefPolicy()
Retrieves the alias dereferencing policy for this search operation.- Returns:
- The alias dereferencing policy for this search operation.
-
getSizeLimit
int getSizeLimit()
Retrieves the size limit for this search operation.- Returns:
- The size limit for this search operation.
-
getTimeLimit
int getTimeLimit()
Retrieves the time limit for this search operation.- Returns:
- The time limit for this search operation.
-
getTypesOnly
boolean getTypesOnly()
Retrieves the typesOnly flag for this search operation.- Returns:
- The typesOnly flag for this search operation.
-
getFilter
Filter getFilter()
Retrieves the filter for this search operation.- Returns:
- The filter for this search operation.
-
-