OSID Logo
OSID Specifications
forum batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.batch.ForumBatchProxyManager
Implementsosid.OsidProxyManager
osid.forum.batch.ForumBatchProfile
Description

The forum batch proxy manager provides access to forum batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.batch.PostBatchAdminSessiona PostBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostBatchAdmin() is false
ComplianceoptionalThis 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.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.batch.PostBatchAdminSessiona PostBatchAdminSession
ErrorsNOT_FOUNDno Forum found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostBatchAdmin() and supportsVisibleFederation() are true
MethodgetReplyBatchAdminSession
Description

Gets the OsidSession associated with the bulk reply administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.batch.ReplyBatchAdminSessiona ReplyBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyBatchAdmin() is false
ComplianceoptionalThis 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.IdforumIdthe Id of the Forum
osid.proxy.Proxyproxya proxy
Returnosid.forum.batch.ReplyBatchAdminSessiona ReplyBatchAdminSession
ErrorsNOT_FOUNDno Forum found by the given Id
NULL_ARGUMENT forumId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsReplyBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsReplyBatchAdmin() and supportsVisibleFederation() are true
MethodgetForumBatchAdminSession
Description

Gets the OsidSession associated with the bulk forum administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.forum.batch.ForumBatchAdminSessiona ForumBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsForumBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsForumBatchAdmin() is true.