org.osid.forum

Interface ForumProxyManager

All Superinterfaces:

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

public interface ForumProxyManager
extends OsidProxyManager, ForumProfile

The reply manager provides access to forum sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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(Proxy proxy) Gets the OsidSession associated with the forum administrative service.
ForumBatchProxyManager	getForumBatchProxyManager() Gets a ForumBatchProxyManager.
ForumHierarchyDesignSession	getForumHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the forum hierarchy design service.
ForumHierarchySession	getForumHierarchySession(Proxy proxy) Gets the OsidSession associated with the forum hierarchy service.
ForumLookupSession	getForumLookupSession(Proxy proxy) Gets the OsidSession associated with the forum lookup service.
ForumNotificationSession	getForumNotificationSession(ForumReceiver forumReceiver, Proxy proxy) Gets the OsidSession associated with the forum notification service.
ForumQuerySession	getForumQuerySession(Proxy proxy) Gets the OsidSession associated with the forum query service.
ForumSearchSession	getForumSearchSession(Proxy proxy) Gets the OsidSession associated with the forum search service.
PostAdminSession	getPostAdminSession(Proxy proxy) Gets the OsidSession associated with the post administrative service.
PostAdminSession	getPostAdminSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the post administration service for the given forum.
PostForumAssignmentSession	getPostForumAssignmentSession(Proxy proxy) Gets the session for assigning post to forum mappings.
PostForumSession	getPostForumSession(Proxy proxy) Gets the session for retrieving post to forum mappings.
PostLookupSession	getPostLookupSession(Proxy proxy) Gets the OsidSession associated with the post lookup service.
PostLookupSession	getPostLookupSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the post lookup service for the given forum.
PostNotificationSession	getPostNotificationSession(PostReceiver postReceiver, Proxy proxy) Gets the OsidSession associated with the post notification service.
PostNotificationSession	getPostNotificationSessionForForum(PostReceiver postReceiver, Id forumId, Proxy proxy) Gets the OsidSession associated with the post notification service for the given forum.
PostQuerySession	getPostQuerySession(Proxy proxy) Gets the OsidSession associated with the post query service.
PostQuerySession	getPostQuerySessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the post query service for the given forum.
PostSearchSession	getPostSearchSession(Proxy proxy) Gets the OsidSession associated with the post search service.
PostSearchSession	getPostSearchSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the post search service for the given forum.
PostSmartForumSession	getPostSmartForumSession(Id forumId, Proxy proxy) Gets the session for managing dynamic post forums for the given forum.
ReplyAdminSession	getReplyAdminSession(Proxy proxy) Gets the OsidSession associated with the reply administration service.
ReplyAdminSession	getReplyAdminSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the reply administration service for the given forum.
ReplyLookupSession	getReplyLookupSession(Proxy proxy) Gets the OsidSession associated with the reply lookup service.
ReplyLookupSession	getReplyLookupSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the reply lookup service for the given forum.
ReplyNotificationSession	getReplyNotificationSession(ReplyReceiver replyReceiver, Proxy proxy) Gets the OsidSession associated with the reply notification service.
ReplyNotificationSession	getReplyNotificationSessionForForum(ReplyReceiver replyReceiver, Id forumId, Proxy proxy) Gets the OsidSession associated with the reply notification service for the given forum.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the post lookup service.

Parameters:

proxy - a proxy

Returns:

a PostLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a PostLookupSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the post query service.

Parameters:

proxy - a proxy

Returns:

a PostQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a PostQuerySession

Throws:

NotFoundException - no Post found by the given Id

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the post search service.

Parameters:

proxy - a proxy

Returns:

a PostSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a PostSearchSession

Throws:

NotFoundException - no Post found by the given Id

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the post administrative service.

Parameters:

proxy - a proxy

Returns:

a PostAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a PostAdminSession

Throws:

NotFoundException - no Post found by the given Id

NullArgumentException - forumId or proxy 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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the post notification service.

Parameters:

postReceiver - the receiver

proxy - a proxy

Returns:

a PostNotificationSession

Throws:

NullArgumentException - postReceiver or proxy 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,
                                                         Proxy proxy)
                                                           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

proxy - a proxy

Returns:

a PostNotificationSession

Throws:

NotFoundException - no Post found by the given Id

NullArgumentException - postReceiver, forumId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the session for retrieving post to forum mappings.

Parameters:

proxy - a proxy

Returns:

a PostForumSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostForum() is false

Compliance:

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

getPostForumAssignmentSession

PostForumAssignmentSession getPostForumAssignmentSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the session for assigning post to forum mappings.

Parameters:

proxy - a proxy

Returns:

a PostForumAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the session for managing dynamic post forums for the given forum.

Parameters:

forumId - the Id of a forum

proxy - a proxy

Returns:

forumId not found

Throws:

NotFoundException - forumId or proxy is null

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the reply lookup service.

Parameters:

proxy - a proxy

Returns:

a ReplyLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a ReplyLookupSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the reply administration service.

Parameters:

proxy - a proxy

Returns:

a ReplyAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a ReplyAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the reply notification service.

Parameters:

replyReceiver - the receiver

proxy - a proxy

Returns:

a ReplyNotificationSession

Throws:

NullArgumentException - replyReceiver or proxy 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,
                                                           Proxy proxy)
                                                             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

proxy - a proxy

Returns:

a ReplyNotificationSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - replyReceiver, forumId, or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the forum lookup service.

Parameters:

proxy - a proxy

Returns:

a ForumLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumLookup() is false

Compliance:

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

getForumQuerySession

ForumQuerySession getForumQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the forum query service.

Parameters:

proxy - a proxy

Returns:

a ForumQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumQuery() is false

Compliance:

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

getForumSearchSession

ForumSearchSession getForumSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the forum search service.

Parameters:

proxy - a proxy

Returns:

a ForumSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumSearch() is false

Compliance:

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

getForumAdminSession

ForumAdminSession getForumAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the forum administrative service.

Parameters:

proxy - a proxy

Returns:

a ForumAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the forum notification service.

Parameters:

forumReceiver - the receiver

proxy - a proxy

Returns:

a ForumNotificationSession

Throws:

NullArgumentException - forumReceiver or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the forum hierarchy service.

Parameters:

proxy - a proxy

Returns:

a ForumHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumHierarchy() is false

Compliance:

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

getForumHierarchyDesignSession

ForumHierarchyDesignSession getForumHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the forum hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a ForumHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumHierarchyDesign() is false

Compliance:

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

getForumBatchProxyManager

ForumBatchProxyManager getForumBatchProxyManager()
                                                 throws OperationFailedException

Gets a ForumBatchProxyManager.

Returns:

a ForumBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumBatch() is false

Compliance:

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