| Interface | osid.forum.batch.ForumBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.forum.batch.ForumBatchProfile | |||
| Description |
The forum batch manager provides access to forum batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getPostBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.forum.batch.PostBatchAdminSession | a PostBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPostBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPostBatchAdmin()
is true. | |
| Method | getPostBatchAdminSessionForForum | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | forumId | the Id of the Forum |
| Return | osid.forum.batch.PostBatchAdminSession | a PostBatchAdminSession | |
| Errors | NOT_FOUND | no Forum found by the given Id | |
| NULL_ARGUMENT | forumId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPostBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPostBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getReplyBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.forum.batch.ReplyBatchAdminSession | a ReplyBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsReplyBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsReplyBatchAdmin()
is true. | |
| Method | getReplyBatchAdminSessionForForum | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | forumId | the Id of the Forum |
| Return | osid.forum.batch.ReplyBatchAdminSession | a ReplyBatchAdminSession | |
| Errors | NOT_FOUND | no Forum found by the given Id | |
| NULL_ARGUMENT | forumId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsReplyBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsReplyBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getForumBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.forum.batch.ForumBatchAdminSession | a ForumBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsForumBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsForumBatchAdmin()
is true. | |