public interface DirectorySearchSession extends DirectoryQuerySession
This session provides methods for searching among Directory
objects. The search query is constructed using the
DirectoryQuery.
This session defines views that offer differing behaviors for searching.
getDirectoriesByQuery()
is the basic search method and
returns a list of Directories.
A more advanced search may
be performed with getDirectoriesBySearch().
It accepts a
DirectorySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getDirectoriesBySearch()
returns an
DirectorySearchResults
that can be used to access the resulting
DirectoryList
or be used to perform a search within the
result set through DirectorySearch.
Modifier and Type | Method and Description |
---|---|
DirectorySearchResults |
getDirectoriesBySearch(DirectoryQuery directoryQuery,
DirectorySearch directorySearch)
Gets the search results matching the given search.
|
DirectoryQuery |
getDirectoryQueryFromInspector(DirectoryQueryInspector directoryQueryInspector)
Gets a directory query from an inspector.
|
DirectorySearch |
getDirectorySearch()
Gets a diectory search.
|
DirectorySearchOrder |
getDirectorySearchOrder()
Gets a directory search order.
|
canSearchDirectories, getDirectoriesByQuery, getDirectory, getDirectoryId, getDirectoryQuery, useFederatedDirectoryView, useIsolatedDirectoryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DirectorySearch getDirectorySearch()
mandatory
- This method must be implemented. DirectorySearchOrder getDirectorySearchOrder()
DirectorySearchOrder
is supplied to a DirectorySearch
to specify the
ordering of results.mandatory
- This method must be implemented. DirectorySearchResults getDirectoriesBySearch(DirectoryQuery directoryQuery, DirectorySearch directorySearch) throws OperationFailedException, PermissionDeniedException
directoryQuery
- the directory querydirectorySearch
- the directory searchNullArgumentException
- directoryQuery
or directorySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- directoryQuery
or
directorySearch
is not of this servicemandatory
- This method must be implemented. DirectoryQuery getDirectoryQueryFromInspector(DirectoryQueryInspector directoryQueryInspector)
DirectorySearchResults.
directoryQueryInspector
- a query inspectorNullArgumentException
- directoryQueryInspector
is null
UnsupportedException
- directoryQueryInspector
is not of this servicemandatory
- This method must be implemented.