public interface PostSearchSession extends PostQuerySession
This session provides methods for searching among Post
objects. The search query is constructed using the PostQuery.
getPostsByQuery()
is the basic search method and
returns a list of Posts.
A more advanced search may be
performed with getPostsBySearch().
It accepts a
PostSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getPostsBySearch()
returns a PostSearchResults
that
can be used to access the resulting PostList
or be used to
perform a search within the result set through PostSearch.
This session defines views that offer differing behaviors for searching.
Posts may have a query record indicated by their respective record
types. The queryrecord is accessed via the PostQuery.
Modifier and Type | Method and Description |
---|---|
PostQuery |
getPostQueryFromInspector(ItemQueryInspector postQueryInspector)
Gets a post query from an inspector.
|
PostSearchResults |
getPostsBySearch(PostQuery postQuery,
PostSearch postSearch)
Gets the search results matching the given search query using the
given search.
|
PostSearch |
getPostSearch()
Gets a post search.
|
PostSearchOrder |
getPostSearchOrder()
Gets a post search order.
|
canSearchPosts, getBusiness, getBusinessId, getPostQuery, getPostsByQuery, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PostSearch getPostSearch()
mandatory
- This method must be implemented. PostSearchOrder getPostSearchOrder()
PostSearchOrder
is
supplied to a PostSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PostSearchResults getPostsBySearch(PostQuery postQuery, PostSearch postSearch) throws OperationFailedException, PermissionDeniedException
postQuery
- the post querypostSearch
- the post searchNullArgumentException
- postQuery
or
postSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- postQuery
or
postSearch
is not of this servicemandatory
- This method must be implemented. PostQuery getPostQueryFromInspector(ItemQueryInspector postQueryInspector)
PostSearchResults.
postQueryInspector
- a post query inspectorNullArgumentException
- postQueryInspector
is null
UnsupportedException
- postQueryInspector
is not of this servicemandatory
- This method must be implemented.