public interface EntrySearchSession extends EntryQuerySession
This session provides methods for searching among Entry
objects. The search query is constructed using the EntryQuery.
getEntriesByQuery()
is the basic search method and
returns a list of Entrys.
A more advanced search may be
performed with getEntrysBySearch().
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 an EntrySearchResults
that can be used to access the resulting EntryList
or be
used to perform a search within the result set through EntrySearch.
This session defines views that offer differing behaviors for searching.
Entries may have a query record indicated by their respective record
types. The query record is accessed via the EntryQuery.
Modifier and Type | Method and Description |
---|---|
EntrySearchResults |
getEntriesBySearch(EntryQuery entryQuery,
EntrySearch entrySearch)
Gets the search results matching the given search query using 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, getBusiness, getBusinessId, getEntriesByQuery, getEntryQuery, useFederatedBusinessView, useIsolatedBusinessView
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 an EntrySearch
to specify the ordering of
results.mandatory
- This method must be implemented. EntrySearchResults getEntriesBySearch(EntryQuery entryQuery, EntrySearch entrySearch) throws OperationFailedException, PermissionDeniedException
entryQuery
- the entry queryentrySearch
- the entry searchNullArgumentException
- entryQuery
or
entrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- entryQuery
or
entrySearch
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.