public interface PostSmartForumSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PostQuery
can be retrieved from this session
and mapped to this Forum
to create a virtual collection of
Posts.
The posts may be sequenced using the
PostSearchOrder
from this session.
This Forum
has a default query that matches any post
and a default search order that specifies no sequencing. The queries may
be examined using a PostQueryInspector.
The query may be
modified by converting the inspector back to a PostQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPostQuery(PostQuery postQuery)
Applies a post query to this forum.
|
void |
applyPostSequencing(PostSearchOrder postSearchOrder)
Applies a post search order to this forum.
|
boolean |
canManageSmartForums()
Tests if this user can manage smart forums.
|
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.
|
PostQuery |
getPostQueryFromInspector(PostQueryInspector postQueryInspector)
Gets a post query from an inspector.
|
PostSearchOrder |
getPostSearchOrder()
Gets a post search order.
|
PostQueryInspector |
inspectPostQuery()
Gets a post query inspector for this forum.
|
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. Forum
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartForums()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart forum management is not
authorized, true
otherwisemandatory
- This method must be implemented. PostQuery getPostQuery()
mandatory
- This method must be implemented. PostSearchOrder getPostSearchOrder()
mandatory
- This method must be implemented. void applyPostQuery(PostQuery postQuery) throws OperationFailedException, PermissionDeniedException
postQuery
- the post queryNullArgumentException
- postQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- postQuery
not of
this servicemandatory
- This method must be implemented. PostQueryInspector inspectPostQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPostSequencing(PostSearchOrder postSearchOrder) throws OperationFailedException, PermissionDeniedException
postSearchOrder
- the post search orderNullArgumentException
- postSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- postSearchOrder
not of this servicemandatory
- This method must be implemented. PostQuery getPostQueryFromInspector(PostQueryInspector postQueryInspector)
postQueryInspector
- a query inspectorNullArgumentException
- postQueryInspector
is null
UnsupportedException
- postQueryInspector
is not of this servicemandatory
- This method must be implemented.