OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ForumProxyManager
Implementsosid.OsidProxyManager
osid.forum.ForumProfile
Description

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.

MethodgetPostLookupSession
Description

Gets the OsidSession associated with the post lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.PostLookupSessiona PostLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostLookup() is false
ComplianceoptionalThis method must be implemented if supportsPostLookup() is true.
MethodgetPostLookupSessionForForum
Description

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

Parametersosid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostLookupSessiona PostLookupSession
ErrorsNOT_FOUNDno Forum found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostLookup() and supportsVisibleFederation() are true
MethodgetPostQuerySession
Description

Gets the OsidSession associated with the post query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.PostQuerySessiona PostQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostQuery() is false
ComplianceoptionalThis method must be implemented if supportsPostQuery() is true.
MethodgetPostQuerySessionForForum
Description

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

Parametersosid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostQuerySessiona PostQuerySession
ErrorsNOT_FOUNDno Post found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostQuery() and supportsVisibleFederation() are true
MethodgetPostSearchSession
Description

Gets the OsidSession associated with the post search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.PostSearchSessiona PostSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostSearch() is false
ComplianceoptionalThis method must be implemented if supportsPostSearch() is true.
MethodgetPostSearchSessionForForum
Description

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

Parametersosid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostSearchSessiona PostSearchSession
ErrorsNOT_FOUNDno Post found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostSearch() and supportsVisibleFederation() are true
MethodgetPostAdminSession
Description

Gets the OsidSession associated with the post administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.PostAdminSessiona PostAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPostAdmin() is true.
MethodgetPostAdminSessionForForum
Description

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

Parametersosid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostAdminSessiona PostAdminSession
ErrorsNOT_FOUNDno Post found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostAdmin() and supportsVisibleFederation() are true
MethodgetPostNotificationSession
Description

Gets the OsidSession associated with the post notification service.

Parametersosid.forum.PostReceiverpostReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostNotificationSessiona PostNotificationSession
ErrorsNULL_ARGUMENT postReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostNotification() is false
ComplianceoptionalThis method must be implemented if supportsPostNotification() is true.
MethodgetPostNotificationSessionForForum
Description

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

Parametersosid.forum.PostReceiverpostReceiverthe receiver
osid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostNotificationSessiona PostNotificationSession
ErrorsNOT_FOUNDno Post found by the given Id
NULL_ARGUMENT postReceiver, forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostNotification() and supportsVisibleFederation() are true
MethodgetPostForumSession
Description

Gets the session for retrieving post to forum mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.PostForumSessiona PostForumSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostForum() is false
ComplianceoptionalThis method must be implemented if supportsPostForum() is true.
MethodgetPostForumAssignmentSession
Description

Gets the session for assigning post to forum mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.PostForumAssignmentSessiona PostForumAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostForumAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPostForumAssignment() is true.
MethodgetPostSmartForumSession
Description

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

Parametersosid.id.IdforumIdthe Id of a forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.PostSmartForumSession forumId not found
ErrorsNOT_FOUND forumId or proxy is null
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostSmartForum() is false
ComplianceoptionalThis method must be implemented if supportsPostSmartForum() is true.
MethodgetReplyLookupSession
Description

Gets the OsidSession associated with the reply lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ReplyLookupSessiona ReplyLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyLookup() is false
ComplianceoptionalThis method must be implemented if supportsReplyLookup() is true.
MethodgetReplyLookupSessionForForum
Description

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

Parametersosid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.ReplyLookupSessiona ReplyLookupSession
ErrorsNOT_FOUNDno Forum found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsReplyLookup() and supportsVisibleFederation() are true
MethodgetReplyAdminSession
Description

Gets the OsidSession associated with the reply administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ReplyAdminSessiona ReplyAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsReplyAdmin() is true.
MethodgetReplyAdminSessionForForum
Description

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

Parametersosid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.ReplyAdminSessiona ReplyAdminSession
ErrorsNOT_FOUNDno Forum found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsReplyAdmin() and supportsVisibleFederation() are true
MethodgetReplyNotificationSession
Description

Gets the OsidSession associated with the reply notification service.

Parametersosid.forum.ReplyReceiverreplyReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.forum.ReplyNotificationSessiona ReplyNotificationSession
ErrorsNULL_ARGUMENT replyReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyNotification() is false
ComplianceoptionalThis method must be implemented if supportsReplyNotification() is true.
MethodgetReplyNotificationSessionForForum
Description

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

Parametersosid.forum.ReplyReceiverreplyReceiverthe receiver
osid.id.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.ReplyNotificationSessiona ReplyNotificationSession
ErrorsNOT_FOUNDno Forum found by the given Id
NULL_ARGUMENT replyReceiver, forumId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsReplyNotification() and supportsVisibleFederation() are true
MethodgetForumLookupSession
Description

Gets the OsidSession associated with the forum lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ForumLookupSessiona ForumLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumLookup() is false
ComplianceoptionalThis method must be implemented if supportsForumLookup() is true.
MethodgetForumQuerySession
Description

Gets the OsidSession associated with the forum query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ForumQuerySessiona ForumQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumQuery() is false
ComplianceoptionalThis method must be implemented if supportsForumQuery() is true.
MethodgetForumSearchSession
Description

Gets the OsidSession associated with the forum search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ForumSearchSessiona ForumSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumSearch() is false
ComplianceoptionalThis method must be implemented if supportsForumSearch() is true.
MethodgetForumAdminSession
Description

Gets the OsidSession associated with the forum administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ForumAdminSessiona ForumAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumAdmin() is false
ComplianceoptionalThis method must be implemented if supportsForumAdmin() is true.
MethodgetForumNotificationSession
Description

Gets the OsidSession associated with the forum notification service.

Parametersosid.forum.ForumReceiverforumReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.forum.ForumNotificationSessiona ForumNotificationSession
ErrorsNULL_ARGUMENT forumReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumNotification() is false
ComplianceoptionalThis method must be implemented if supportsForumNotification() is true.
MethodgetForumHierarchySession
Description

Gets the OsidSession associated with the forum hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ForumHierarchySessiona ForumHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsForumHierarchy() is true.
MethodgetForumHierarchyDesignSession
Description

Gets the OsidSession associated with the forum hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.ForumHierarchyDesignSessiona ForumHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsForumHierarchyDesign() is true.
MethodgetForumBatchProxyManager
Description

Gets a ForumBatchProxyManager.

Returnosid.forum.batch.ForumBatchProxyManagera ForumBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumBatch() is false
ComplianceoptionalThis method must be implemented if supportsForumBatch() is true.