OSID Logo
OSID Specifications
forum batch package
Version 3.1.0
Interfaceosid.forum.batch.ForumBatchManager
Implementsosid.OsidManager
osid.forum.batch.ForumBatchProfile
Used Byosid.forum.ForumManager
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:

  • PostBatchSession: a session to create, modify and delete posts in bulk
  • ReplyBatchAdminSession: a session to create, modify and delete replies in bulk
  • ForumBatchAdminSession: a session to create, modify and delete forums in bulk
MethodgetPostBatchAdminSession
Description

Gets the OsidSession associated with the bulk post administration service.

Returnosid.forum.batch.PostBatchAdminSession a PostBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPostBatchAdmin() is false
Complianceoptional This method must be implemented if supportsPostBatchAdmin() is true.
MethodgetPostBatchAdminSessionForForum
Description

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

Parametersosid.id.IdforumId the Id of the Forum
Returnosid.forum.batch.PostBatchAdminSession a PostBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsPostBatchAdmin() and supportsVisibleFederation() are true
MethodgetReplyBatchAdminSession
Description

Gets the OsidSession associated with the bulk reply administration service.

Returnosid.forum.batch.ReplyBatchAdminSession a ReplyBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsReplyBatchAdmin() is false
Complianceoptional This method must be implemented if supportsReplyBatchAdmin() is true.
MethodgetReplyBatchAdminSessionForForum
Description

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

Parametersosid.id.IdforumId the Id of the Forum
Returnosid.forum.batch.ReplyBatchAdminSession a ReplyBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsReplyBatchAdmin() and supportsVisibleFederation() are true
MethodgetForumBatchAdminSession
Description

Gets the OsidSession associated with the bulk forum administration service.

Returnosid.forum.batch.ForumBatchAdminSession a ForumBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsForumBatchAdmin() is false
Complianceoptional This method must be implemented if supportsForumBatchAdmin() is true.