public interface ForumSearchSession extends ForumQuerySession
This session provides methods for searching Forum
objects. The search query is constructed using the ForumQuery.
The forum record Type
also specifies the record for
the forum query.
getForumsByQuery()
is the basic search method and
returns a list of Forum
elements. A more advanced search
may be performed with getForumsBySearch().
It accepts a
ForumSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getForumsBySearch()
returns a
ForumSearchResults
that can be used to access the resulting
ForumList
or be used to perform a search within the result set
through ForumSearch.
Forums may have a query record indicated by their respective record
types. The query record is accessed via the ForumQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
ForumQuery |
getForumQueryFromInspector(ForumQueryInspector forumQueryInspector)
Gets a forum query from an inspector.
|
ForumSearchResults |
getForumsBySearch(ForumQuery forumQuery,
ForumSearch forumSearch)
Gets the search results matching the given search.
|
ForumSearch |
getForumSearch()
Gets a forum search.
|
ForumSearchOrder |
getForumSearchOrder()
Gets a forum search order.
|
canSearchForums, getForumQuery, getForumsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ForumSearch getForumSearch()
mandatory
- This method must be implemented. ForumSearchOrder getForumSearchOrder()
ForumSearchOrder
is
supplied to a ForumSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ForumSearchResults getForumsBySearch(ForumQuery forumQuery, ForumSearch forumSearch) throws OperationFailedException, PermissionDeniedException
forumQuery
- the forum queryforumSearch
- the forum searchNullArgumentException
- forumQuery
or
forumSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- forumQuery
or
forumSearch
is not of this servicemandatory
- This method must be implemented. ForumQuery getForumQueryFromInspector(ForumQueryInspector forumQueryInspector)
ForumSearchResults.
forumQueryInspector
- a query inspectorNullArgumentException
- forumQueryInspector
is null
UnsupportedException
- forumQueryInspector
is not of this servicemandatory
- This method must be implemented.