Interface | osid.forum.ForumProxyManager | ||
---|---|---|---|
Implements | osid.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
The forum manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getPostLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.PostLookupSession | a PostLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPostLookup() is
true. | |
Method | getPostLookupSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostLookupSession | a PostLookupSession | |
Errors | NOT_FOUND | no Forum found by the given Id | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostLookup() and
supportsVisibleFederation() are true | |
Method | getPostQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.PostQuerySession | a PostQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPostQuery() is
true. | |
Method | getPostQuerySessionForForum | ||
Description |
Gets the | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostQuerySession | a PostQuerySession | |
Errors | NOT_FOUND | no Post found by the given Id | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostQuery() and
supportsVisibleFederation() are true | |
Method | getPostSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.PostSearchSession | a PostSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPostSearch() is
true. | |
Method | getPostSearchSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostSearchSession | a PostSearchSession | |
Errors | NOT_FOUND | no Post found by the given Id | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostSearch() and
supportsVisibleFederation() are true | |
Method | getPostAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.PostAdminSession | a PostAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPostAdmin() is
true. | |
Method | getPostAdminSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostAdminSession | a PostAdminSession | |
Errors | NOT_FOUND | no Post found by the given Id | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostAdmin() and
supportsVisibleFederation() are true | |
Method | getPostNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.forum.PostReceiver | postReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostNotificationSession | a PostNotificationSession | |
Errors | NULL_ARGUMENT | postReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPostNotification()
is true. | |
Method | getPostNotificationSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.forum.PostReceiver | postReceiver | the receiver |
osid.id.Id | forumId | the Id of the Forum | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostNotificationSession | a PostNotificationSession | |
Errors | NOT_FOUND | no Post found by the given Id | |
NULL_ARGUMENT | postReceiver, forumId or proxy is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostNotification()
and supportsVisibleFederation() are true | |
Method | getPostForumSession | ||
Description |
Gets the session for retrieving post to forum mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.PostForumSession | a PostForumSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostForum() is false | ||
Compliance | optional | This method must be implemented if supportsPostForum() is
true. | |
Method | getPostForumAssignmentSession | ||
Description |
Gets the session for assigning post to forum mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.PostForumAssignmentSession | a PostForumAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostForumAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsPostForumAssignment()
is true. | |
Method | getPostSmartForumSession | ||
Description |
Gets the session for managing dynamic post forums for the given forum. | ||
Parameters | osid.id.Id | forumId | the Id of a forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.PostSmartForumSession | forumId not found | |
Errors | NOT_FOUND | forumId or proxy is null | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostSmartForum() is false | ||
Compliance | optional | This method must be implemented if supportsPostSmartForum()
is true. | |
Method | getReplyLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ReplyLookupSession | a ReplyLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReplyLookup() is false | ||
Compliance | optional | This method must be implemented if supportsReplyLookup() is
true. | |
Method | getReplyLookupSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.ReplyLookupSession | a ReplyLookupSession | |
Errors | NOT_FOUND | no Forum found by the given Id | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReplyLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsReplyLookup() and
supportsVisibleFederation() are true | |
Method | getReplyAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ReplyAdminSession | a ReplyAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReplyAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsReplyAdmin() is
true. | |
Method | getReplyAdminSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.id.Id | forumId | the Id of the Forum |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.ReplyAdminSession | a ReplyAdminSession | |
Errors | NOT_FOUND | no Forum found by the given Id | |
NULL_ARGUMENT | forumId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReplyAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsReplyAdmin() and
supportsVisibleFederation() are true | |
Method | getReplyNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.forum.ReplyReceiver | replyReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.ReplyNotificationSession | a ReplyNotificationSession | |
Errors | NULL_ARGUMENT | replyReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReplyNotification() is false | ||
Compliance | optional | This method must be implemented if supportsReplyNotification()
is true. | |
Method | getReplyNotificationSessionForForum | ||
Description |
Gets the | ||
Parameters | osid.forum.ReplyReceiver | replyReceiver | the receiver |
osid.id.Id | forumId | the Id of the Forum | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.ReplyNotificationSession | a ReplyNotificationSession | |
Errors | NOT_FOUND | no Forum found by the given Id | |
NULL_ARGUMENT | replyReceiver, forumId, or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReplyNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsReplyNotification()
and supportsVisibleFederation() are true | |
Method | getForumLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ForumLookupSession | a ForumLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumLookup() is false | ||
Compliance | optional | This method must be implemented if supportsForumLookup() is
true. | |
Method | getForumQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ForumQuerySession | a ForumQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumQuery() is false | ||
Compliance | optional | This method must be implemented if supportsForumQuery() is
true. | |
Method | getForumSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ForumSearchSession | a ForumSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumSearch() is false | ||
Compliance | optional | This method must be implemented if supportsForumSearch() is
true. | |
Method | getForumAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ForumAdminSession | a ForumAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsForumAdmin() is
true. | |
Method | getForumNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.forum.ForumReceiver | forumReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.forum.ForumNotificationSession | a ForumNotificationSession | |
Errors | NULL_ARGUMENT | forumReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumNotification() is false | ||
Compliance | optional | This method must be implemented if supportsForumNotification()
is true. | |
Method | getForumHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ForumHierarchySession | a ForumHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsForumHierarchy()
is true. | |
Method | getForumHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.forum.ForumHierarchyDesignSession | a ForumHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsForumHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsForumHierarchyDesign()
is true. | |
Method | getForumBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.forum.batch.ForumBatchProxyManager | a ForumBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsForumBatch() is false | ||
Compliance | optional | This method must be implemented if supportsForumBatch() is
true. |