public interface ForumQuerySession extends OsidSession
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.
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 |
---|---|
boolean |
canSearchForums()
Tests if this user can perform
Forum searches. |
ForumQuery |
getForumQuery()
Gets a forum query.
|
ForumList |
getForumsByQuery(ForumQuery forumQuery)
Gets a list of
Forums matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchForums()
Forum
searches. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. ForumQuery getForumQuery()
mandatory
- This method must be implemented. ForumList getForumsByQuery(ForumQuery forumQuery) throws OperationFailedException, PermissionDeniedException
Forums
matching the given search.forumQuery
- the forum query ForumList
NullArgumentException
- forumQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- forumQuery
is not
of this servicemandatory
- This method must be implemented.