public interface EntrySearchSession extends EntryQuerySession
This session provides methods for searching among entries. The search
query is constructed using the EntryQuery.
getEntryByQuery()
is the basic search method and
returns a list of Entries.
A more advanced search may be
performed with getEntriesBySearch().
It accepts an
EntrySearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getEntriesBySearch()
returns a EntrySearchResult
that can be used to access the resulting EntryList
or be
used to perform a search within the result set through EntrySearch.
Modifier and Type | Method and Description |
---|---|
EntrySearchResults |
getEntriesBySearch(EntryQuery entryQuery,
EntrySearch entrySearch)
Gets a list of
Entry elements matching the given
search. |
EntryQuery |
getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
Gets an entry query from an inspector.
|
EntrySearch |
getEntrySearch()
Gets an entry search.
|
EntrySearchOrder |
getEntrySearchOrder()
Gets an entry search order.
|
canSearchEntries, getDictionary, getDictionaryId, getEntriesByQuery, getEntryQuery, useFederatedDictionaryView, useIsolatedDictionaryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
EntrySearch getEntrySearch()
mandatory
- This method must be implemented. EntrySearchOrder getEntrySearchOrder()
EntrySearchOrder
is
supplied to a EntrySearch
to specify the ordering of
results.mandatory
- This method must be implemented. EntrySearchResults getEntriesBySearch(EntryQuery entryQuery, EntrySearch entrySearch) throws OperationFailedException, PermissionDeniedException
Entry
elements matching the given
search.entryQuery
- the entry queryentrySearch
- the entry searchNullArgumentException
- entryQuery
or
entrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- entrySearch
or
entryQuery
is not of this servicemandatory
- This method must be implemented. EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
EntrySearchResults.
entryQueryInspector
- an entry query inspectorNullArgumentException
- entryQueryInspector
is null
UnsupportedException
- entryQueryInspector
is not of this servicemandatory
- This method must be implemented.