public interface PostQuerySession extends OsidSession
This session provides methods for searching Post
objects. The search query is constructed using the PostQuery.
The post record Type
also specifies the record for
the post query.
Posts may have a query record indicated by their respective record
types. The query record is accessed via the PostQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPosts()
Tests if this user can perform
Post searches. |
Forum |
getForum()
Gets the
Forum associated with this session. |
Id |
getForumId()
Gets the
Forum Id associated with this
session. |
PostQuery |
getPostQuery()
Gets a post query.
|
PostList |
getPostsByQuery(PostQuery postQuery)
Gets a list of
Posts matching the given search. |
void |
useFederatedForumView()
Federates the view for methods in this session.
|
void |
useIsolatedForumView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getForumId()
Forum
Id
associated with this
session. Forum Id
associated with this sessionmandatory
- This method must be implemented. Forum getForum() throws OperationFailedException, PermissionDeniedException
Forum
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void useFederatedForumView()
mandatory
- This method is must be implemented. void useIsolatedForumView()
mandatory
- This method is must be implemented. boolean canSearchPosts()
Post
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. PostQuery getPostQuery()
mandatory
- This method must be implemented. PostList getPostsByQuery(PostQuery postQuery) throws OperationFailedException, PermissionDeniedException
Posts
matching the given search.postQuery
- the post query PostList
NullArgumentException
- postQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- postQuery
is not
of this servicemandatory
- This method must be implemented.