org.osid.forum

Interface ForumManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ForumProfile, OsidManager, OsidProfile, Sourceable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.forum.ForumProfile

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

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPostLookupSession

PostLookupSession getPostLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the post lookup service.

Returns:

a PostLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostLookup() is false

Compliance:

optional - This method must be implemented if supportsPostLookup() is true.

getPostLookupSessionForForum

PostLookupSession getPostLookupSessionForForum(Id forumId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the post lookup service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostLookupSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPostLookup() and supportsVisibleFederation() are true

getPostQuerySession

PostQuerySession getPostQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the post query service.

Returns:

a PostQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostQuery() is false

Compliance:

optional - This method must be implemented if supportsPostQuery() is true.

getPostQuerySessionForForum

PostQuerySession getPostQuerySessionForForum(Id forumId)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession associated with the post query service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostQuerySession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPostQuery() and supportsVisibleFederation() are true

getPostSearchSession

PostSearchSession getPostSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the post search service.

Returns:

a PostSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSearch() is false

Compliance:

optional - This method must be implemented if supportsPostSearch() is true.

getPostSearchSessionForForum

PostSearchSession getPostSearchSessionForForum(Id forumId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the post search service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostSearchSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPostSearch() and supportsVisibleFederation() are true

getPostAdminSession

PostAdminSession getPostAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the post administrative service.

Returns:

a PostAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostAdmin() is false

Compliance:

optional - This method must be implemented if supportsPostAdmin() is true.

getPostAdminSessionForForum

PostAdminSession getPostAdminSessionForForum(Id forumId)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession associated with the post administrative service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPostAdmin() and supportsVisibleFederation() are true

getPostNotificationSession

PostNotificationSession getPostNotificationSession(PostReceiver postReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the post notification service.

Parameters:

postReceiver - the receiver

Returns:

a PostNotificationSession

Throws:

NullArgumentException - postReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostNotification() is false

Compliance:

optional - This method must be implemented if supportsPostNotification() is true.

getPostNotificationSessionForForum

PostNotificationSession getPostNotificationSessionForForum(PostReceiver postReceiver,
                                                         Id forumId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the post notification service for the given forum.

Parameters:

postReceiver - the receiver

forumId - the Id of the Forum

Returns:

a PostNotificationSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - postReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPostNotification() and supportsVisibleFederation() are true

getPostForumSession

PostForumSession getPostForumSession()
                                     throws OperationFailedException

Gets the session for retrieving post to forum mappings.

Returns:

a PostForumSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostForum() is false

Compliance:

optional - This method must be implemented if supportsPostForum() is true.

getPostForumAssignmentSession

PostForumAssignmentSession getPostForumAssignmentSession()
                                                         throws OperationFailedException

Gets the session for assigning post to forum mappings.

Returns:

a PostForumAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostForumAssignment() is false

Compliance:

optional - This method must be implemented if supportsPostForumAssignment() is true.

getPostSmartForumSession

PostSmartForumSession getPostSmartForumSession(Id forumId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the session associated with the post smart forum for the given forum.

Parameters:

forumId - the Id of the forum

Returns:

a PostSmartForumSession

Throws:

NotFoundException - forumId not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSmartForum() is false

Compliance:

optional - This method must be implemented if supportsPostSmartForum() is true.

getReplyLookupSession

ReplyLookupSession getReplyLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the reply lookup service.

Returns:

a ReplyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyLookup() is false

Compliance:

optional - This method must be implemented if supportsReplyLookup() is true.

getReplyLookupSessionForForum

ReplyLookupSession getReplyLookupSessionForForum(Id forumId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the reply lookup service for the given forum.

Parameters:

forumId - the Id of the Forum

Returns:

a ReplyLookupSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReplyLookup() and supportsVisibleFederation() are true

getReplyAdminSession

ReplyAdminSession getReplyAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the reply administration service.

Returns:

a ReplyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyAdmin() is false

Compliance:

optional - This method must be implemented if supportsReplyAdmin() is true.

getReplyAdminSessionForForum

ReplyAdminSession getReplyAdminSessionForForum(Id forumId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the reply administration service for the given forum.

Parameters:

forumId - the Id of the Forum

Returns:

a ReplyAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReplyAdmin() and supportsVisibleFederation() are true

getReplyNotificationSession

ReplyNotificationSession getReplyNotificationSession(ReplyReceiver replyReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the reply notification service.

Parameters:

replyReceiver - the receiver

Returns:

a ReplyNotificationSession

Throws:

NullArgumentException - replyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyNotification() is false

Compliance:

optional - This method must be implemented if supportsReplyNotification() is true.

getReplyNotificationSessionForForum

ReplyNotificationSession getReplyNotificationSessionForForum(ReplyReceiver replyReceiver,
                                                           Id forumId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the reply notification service for the given forum.

Parameters:

replyReceiver - the receiver

forumId - the Id of the Forum

Returns:

a ReplyNotificationSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - replyReceiver or forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReplyNotification() and supportsVisibleFederation() are true

getForumLookupSession

ForumLookupSession getForumLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the forum lookup service.

Returns:

a ForumLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumLookup() is false

Compliance:

optional - This method must be implemented if supportsForumLookup() is true.

getForumQuerySession

ForumQuerySession getForumQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the forum query service.

Returns:

a ForumQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumQuery() is false

Compliance:

optional - This method must be implemented if supportsForumQuery() is true.

getForumSearchSession

ForumSearchSession getForumSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the forum search service.

Returns:

a ForumSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumSearch() is false

Compliance:

optional - This method must be implemented if supportsForumSearch() is true.

getForumAdminSession

ForumAdminSession getForumAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the forum administrative service.

Returns:

a ForumAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumAdmin() is false

Compliance:

optional - This method must be implemented if supportsForumAdmin() is true.

getForumNotificationSession

ForumNotificationSession getForumNotificationSession(ForumReceiver forumReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the forum notification service.

Parameters:

forumReceiver - the receiver

Returns:

a ForumNotificationSession

Throws:

NullArgumentException - forumReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumNotification() is false

Compliance:

optional - This method must be implemented if supportsForumNotification() is true.

getForumHierarchySession

ForumHierarchySession getForumHierarchySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the forum hierarchy service.

Returns:

a ForumHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumHierarchy() is false

Compliance:

optional - This method must be implemented if supportsForumHierarchy() is true.

getForumHierarchyDesignSession

ForumHierarchyDesignSession getForumHierarchyDesignSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the forum hierarchy design service.

Returns:

a ForumHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsForumHierarchyDesign() is true.

getForumBatchManager

ForumBatchManager getForumBatchManager()
                                       throws OperationFailedException

Gets a ForumBatchManager.

Returns:

a ForumBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumBatch() is false

Compliance:

optional - This method must be implemented if supportsForumBatch() is true.