public interface BlogSearchSession extends BlogQuerySession
This session provides methods for searching among Blog
objects. The search query is constructed using the BlogQuery.
getBlogsByQuery()
is the basic search method and
returns a list of Blog
objects.A more advanced search may
be performed with getBlogsBySearch().
It accepts a
BlogSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getBlogsBySearch()
returns a BlogSearchResults
that
can be used to access the resulting BlogList
or be used to
perform a search within the result set through BlogSearch.
Blogs may have a query record indicated by their respective record
types. The query record is accessed via the BlogQuery.
Modifier and Type | Method and Description |
---|---|
BlogQuery |
getBlogQueryFromInspector(BlogQueryInspector blogQueryInspector)
Gets a blog query from an inspector.
|
BlogSearchResults |
getBlogsBySearch(BlogQuery blogQuery,
BlogSearch blogSearch)
Gets the search results matching the given search query using the
given search.
|
BlogSearch |
getBlogSearch()
Gets a blog search.
|
BlogSearchOrder |
getBlogSearchOrder()
Gets a blog search order.
|
canSearchBlogs, getBlogQuery, getBlogsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BlogSearch getBlogSearch()
mandatory
- This method must be implemented. BlogSearchOrder getBlogSearchOrder()
BlogSearchOrder
is
supplied to a BlogSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BlogSearchResults getBlogsBySearch(BlogQuery blogQuery, BlogSearch blogSearch) throws OperationFailedException, PermissionDeniedException
blogQuery
- the blog queryblogSearch
- the blog searchNullArgumentException
- blogQuery
or
blogSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- blogQuery
or
blogSearch
is not of this servicemandatory
- This method must be implemented. BlogQuery getBlogQueryFromInspector(BlogQueryInspector blogQueryInspector)
BlogSearchResults.
blogQueryInspector
- a query inspectorNullArgumentException
- blogQueryInspector
is null
UnsupportedException
- blogQueryInspector
is not of this servicemandatory
- This method must be implemented.