public interface ForumManager extends OsidManager, ForumProfile
The reply manager provides access to forum sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
PostLookupSession:
a session to retrieve posts
PostQuerySession:
a session to query posts PostSearchSession:
a session to search for posts
PostAdminSession:
a session to create, update and
delete posts PostNotificationSession:
a session to receive
notifications for changes in posts PostForumSession:
a session to lookup post forum
mappings PostForumAssignmentSession:
a session to manage
post forum mappings PostSmartForumSession:
a session to manage smart
forums of posts ReplyLookupSession:
a session to lookup replies
ReplyAdminSession:
a session to manage replies
ReplyNotificationSession:
a session to subscribe
to notifications of reply changes ForumLookupSession:
a session to retrieve forums
ForumQuerySession:
a session to query forums ForumSearchSession:
a session to search for forums
ForumAdminSession:
a session to create, update and
delete forums ForumNotificationSession:
a session to receive
notifications for changes in forums ForumHierarchySession:
a session to traverse
hierarchies of forums ForumHierarchyDesignSession:
a session to manage
hierarchies of forums The forum manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
ForumAdminSession |
getForumAdminSession()
Gets the
OsidSession associated with the forum
administrative service. |
ForumBatchManager |
getForumBatchManager()
Gets a
ForumBatchManager. |
ForumHierarchyDesignSession |
getForumHierarchyDesignSession()
Gets the
OsidSession associated with the forum
hierarchy design service. |
ForumHierarchySession |
getForumHierarchySession()
Gets the
OsidSession associated with the forum
hierarchy service. |
ForumLookupSession |
getForumLookupSession()
Gets the
OsidSession associated with the forum lookup
service. |
ForumNotificationSession |
getForumNotificationSession(ForumReceiver forumReceiver)
Gets the
OsidSession associated with the forum
notification service. |
ForumQuerySession |
getForumQuerySession()
Gets the
OsidSession associated with the forum query
service. |
ForumSearchSession |
getForumSearchSession()
Gets the
OsidSession associated with the forum search
service. |
PostAdminSession |
getPostAdminSession()
Gets the
OsidSession associated with the post
administrative service. |
PostAdminSession |
getPostAdminSessionForForum(Id forumId)
Gets the
OsidSession associated with the post
administrative service for the given forum. |
PostForumAssignmentSession |
getPostForumAssignmentSession()
Gets the session for assigning post to forum mappings.
|
PostForumSession |
getPostForumSession()
Gets the session for retrieving post to forum mappings.
|
PostLookupSession |
getPostLookupSession()
Gets the
OsidSession associated with the post lookup
service. |
PostLookupSession |
getPostLookupSessionForForum(Id forumId)
Gets the
OsidSession associated with the post lookup
service for the given forum. |
PostNotificationSession |
getPostNotificationSession(PostReceiver postReceiver)
Gets the
OsidSession associated with the post
notification service. |
PostNotificationSession |
getPostNotificationSessionForForum(PostReceiver postReceiver,
Id forumId)
Gets the
OsidSession associated with the post
notification service for the given forum. |
PostQuerySession |
getPostQuerySession()
Gets the
OsidSession associated with the post query
service. |
PostQuerySession |
getPostQuerySessionForForum(Id forumId)
Gets the
OsidSession associated with the post query
service for the given forum. |
PostSearchSession |
getPostSearchSession()
Gets the
OsidSession associated with the post search
service. |
PostSearchSession |
getPostSearchSessionForForum(Id forumId)
Gets the
OsidSession associated with the post search
service for the given forum. |
PostSmartForumSession |
getPostSmartForumSession(Id forumId)
Gets the session associated with the post smart forum for the given
forum.
|
ReplyAdminSession |
getReplyAdminSession()
Gets the
OsidSession associated with the reply
administration service. |
ReplyAdminSession |
getReplyAdminSessionForForum(Id forumId)
Gets the
OsidSession associated with the reply
administration service for the given forum. |
ReplyLookupSession |
getReplyLookupSession()
Gets the
OsidSession associated with the reply lookup
service. |
ReplyLookupSession |
getReplyLookupSessionForForum(Id forumId)
Gets the
OsidSession associated with the reply lookup
service for the given forum. |
ReplyNotificationSession |
getReplyNotificationSession(ReplyReceiver replyReceiver)
Gets the
OsidSession associated with the reply
notification service. |
ReplyNotificationSession |
getReplyNotificationSessionForForum(ReplyReceiver replyReceiver,
Id forumId)
Gets the
OsidSession associated with the reply
notification service for the given forum. |
changeBranch, initialize, rollbackService
close
getForumRecordTypes, getForumSearchRecordTypes, getPostRecordTypes, getPostSearchRecordTypes, getReplyRecordTypes, getReplySearchRecordTypes, supportsForumAdmin, supportsForumBatch, supportsForumHierarchy, supportsForumHierarchyDesign, supportsForumLookup, supportsForumNotification, supportsForumQuery, supportsForumRecordType, supportsForumSearch, supportsForumSearchRecordType, supportsPostAdmin, supportsPostForum, supportsPostForumAssignment, supportsPostLookup, supportsPostNotification, supportsPostQuery, supportsPostRecordType, supportsPostSearch, supportsPostSearchRecordType, supportsPostSmartForum, supportsReplyAdmin, supportsReplyLookup, supportsReplyNotification, supportsReplyRecordType, supportsReplySearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PostLookupSession getPostLookupSession() throws OperationFailedException
OsidSession
associated with the post lookup
service. PostLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostLookup()
is false
optional
- This method must be implemented if
supportsPostLookup()
is true.
PostLookupSession getPostLookupSessionForForum(Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the post lookup
service for the given forum.forumId
- the Id
of the Post
PostLookupSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostLookup()
and
supportsVisibleFederation()
are true
PostQuerySession getPostQuerySession() throws OperationFailedException
OsidSession
associated with the post query
service. PostQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostQuery()
is false
optional
- This method must be implemented if
supportsPostQuery()
is true.
PostQuerySession getPostQuerySessionForForum(Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the post query
service for the given forum.forumId
- the Id
of the Post
PostQuerySession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostQuery()
and
supportsVisibleFederation()
are true
PostSearchSession getPostSearchSession() throws OperationFailedException
OsidSession
associated with the post search
service. PostSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostSearch()
is false
optional
- This method must be implemented if
supportsPostSearch()
is true.
PostSearchSession getPostSearchSessionForForum(Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the post search
service for the given forum.forumId
- the Id
of the Post
PostSearchSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostSearch()
and
supportsVisibleFederation()
are true
PostAdminSession getPostAdminSession() throws OperationFailedException
OsidSession
associated with the post
administrative service. PostAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostAdmin()
is false
optional
- This method must be implemented if
supportsPostAdmin()
is true.
PostAdminSession getPostAdminSessionForForum(Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the post
administrative service for the given forum.forumId
- the Id
of the Post
PostAdminSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostAdmin()
and
supportsVisibleFederation()
are true
PostNotificationSession getPostNotificationSession(PostReceiver postReceiver) throws OperationFailedException
OsidSession
associated with the post
notification service.postReceiver
- the receiver PostNotificationSession
NullArgumentException
- postReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostNotification()
is false
optional
- This method must be implemented if
supportsPostNotification()
is true.
PostNotificationSession getPostNotificationSessionForForum(PostReceiver postReceiver, Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the post
notification service for the given forum.postReceiver
- the receiverforumId
- the Id
of the Forum
PostNotificationSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- postReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostNotification()
and
supportsVisibleFederation()
are true
PostForumSession getPostForumSession() throws OperationFailedException
PostForumSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostForum()
is false
optional
- This method must be implemented if
supportsPostForum()
is true.
PostForumAssignmentSession getPostForumAssignmentSession() throws OperationFailedException
PostForumAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostForumAssignment()
is false
optional
- This method must be implemented if
supportsPostForumAssignment()
is true.
PostSmartForumSession getPostSmartForumSession(Id forumId) throws NotFoundException, OperationFailedException
forumId
- the Id
of the forum PostSmartForumSession
NotFoundException
- forumId
not foundNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostSmartForum()
is false
optional
- This method must be implemented if
supportsPostSmartForum()
is true.
ReplyLookupSession getReplyLookupSession() throws OperationFailedException
OsidSession
associated with the reply lookup
service. ReplyLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReplyLookup()
is false
optional
- This method must be implemented if
supportsReplyLookup()
is true.
ReplyLookupSession getReplyLookupSessionForForum(Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the reply lookup
service for the given forum.forumId
- the Id
of the Forum
ReplyLookupSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReplyLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReplyLookup()
and
supportsVisibleFederation()
are true
ReplyAdminSession getReplyAdminSession() throws OperationFailedException
OsidSession
associated with the reply
administration service. ReplyAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReplyAdmin()
is false
optional
- This method must be implemented if
supportsReplyAdmin()
is true.
ReplyAdminSession getReplyAdminSessionForForum(Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the reply
administration service for the given forum.forumId
- the Id
of the Forum
ReplyAdminSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsReplyAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsReplyAdmin()
and
supportsVisibleFederation()
are true
ReplyNotificationSession getReplyNotificationSession(ReplyReceiver replyReceiver) throws OperationFailedException
OsidSession
associated with the reply
notification service.replyReceiver
- the receiver ReplyNotificationSession
NullArgumentException
- replyReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReplyNotification()
is false
optional
- This method must be implemented if
supportsReplyNotification()
is true.
ReplyNotificationSession getReplyNotificationSessionForForum(ReplyReceiver replyReceiver, Id forumId) throws NotFoundException, OperationFailedException
OsidSession
associated with the reply
notification service for the given forum.replyReceiver
- the receiverforumId
- the Id
of the Forum
ReplyNotificationSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- replyReceiver
or
forumId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReplyNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsReplyNotification()
and
supportsVisibleFederation()
are true
ForumLookupSession getForumLookupSession() throws OperationFailedException
OsidSession
associated with the forum lookup
service. ForumLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsForumLookup()
is false
optional
- This method must be implemented if
supportsForumLookup()
is true.
ForumQuerySession getForumQuerySession() throws OperationFailedException
OsidSession
associated with the forum query
service. ForumQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsForumQuery()
is false
optional
- This method must be implemented if
supportsForumQuery()
is true.
ForumSearchSession getForumSearchSession() throws OperationFailedException
OsidSession
associated with the forum search
service. ForumSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsForumSearch()
is false
optional
- This method must be implemented if
supportsForumSearch()
is true.
ForumAdminSession getForumAdminSession() throws OperationFailedException
OsidSession
associated with the forum
administrative service. ForumAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsForumAdmin()
is false
optional
- This method must be implemented if
supportsForumAdmin()
is true.
ForumNotificationSession getForumNotificationSession(ForumReceiver forumReceiver) throws OperationFailedException
OsidSession
associated with the forum
notification service.forumReceiver
- the receiver ForumNotificationSession
NullArgumentException
- forumReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsForumNotification()
is false
optional
- This method must be implemented if
supportsForumNotification()
is true.
ForumHierarchySession getForumHierarchySession() throws OperationFailedException
OsidSession
associated with the forum
hierarchy service. ForumHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsForumHierarchy()
is false
optional
- This method must be implemented if
supportsForumHierarchy()
is true.
ForumHierarchyDesignSession getForumHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the forum
hierarchy design service. ForumHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsForumHierarchyDesign()
is false
optional
- This method must be implemented if
supportsForumHierarchyDesign()
is true.
ForumBatchManager getForumBatchManager() throws OperationFailedException
ForumBatchManager.
ForumBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsForumBatch()
is false
optional
- This method must be implemented if
supportsForumBatch()
is true.