public interface PostEntrySearchSession extends PostEntryQuerySession
This session provides methods for searching among PostEntry
objects. The search query is constructed using the
PostEntryQuery.
getPostEntriesByQuery()
is the basic search method and
returns a list of PostEntries.
A more advanced search may
be performed with getPostEntriesBySearch().
It accepts a
PostEntrySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getPostEntriesBySearch()
returns a
PostEntrySearchResults
that can be used to access the resulting
PostEntryList
or be used to perform a search within the
result set through PostEntrySearch.
This session defines views that offer differing behaviors for searching.
Post entries may have a query record indicated by their respective
record types. The query record is accessed via the PostEntryQuery.
Modifier and Type | Method and Description |
---|---|
PostEntrySearchResults |
getPostEntriesBySearch(PostEntryQuery postEntryQuery,
PostEntrySearch postEntrySearch)
Gets the search results matching the given search query using the
given search.
|
PostEntryQuery |
getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)
Gets a post entry query from an inspector.
|
PostEntrySearch |
getPostEntrySearch()
Gets a post entry search.
|
PostEntrySearchOrder |
getPostEntrySearchOrder()
Gets a post entry search order.
|
canSearchPostEntries, getBusiness, getBusinessId, getPostEntriesByQuery, getPostEntryQuery, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PostEntrySearch getPostEntrySearch()
mandatory
- This method must be implemented. PostEntrySearchOrder getPostEntrySearchOrder()
PostEntrySearchOrder
is supplied to a PostEntrySearch
to specify the
ordering of results.mandatory
- This method must be implemented. PostEntrySearchResults getPostEntriesBySearch(PostEntryQuery postEntryQuery, PostEntrySearch postEntrySearch) throws OperationFailedException, PermissionDeniedException
postEntryQuery
- the post entry querypostEntrySearch
- the post entry searchNullArgumentException
- postEntryQuery
or postEntrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- postEntryQuery
or
postEntrySearch
is not of this servicemandatory
- This method must be implemented. PostEntryQuery getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)
PostEntrySearchResults.
postEntryQueryInspector
- a post entry query inspectorNullArgumentException
- postEntryQueryInspector
is null
UnsupportedException
- postEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.