OSID Logo
OSID Specifications
commenting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.batch.CommentingBatchProxyManager
Implementsosid.OsidProxyManager
osid.commenting.batch.CommentingBatchProfile
Description

The commenting batch proxy manager provides access to commenting 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:

  • CommentBatchSession: a session to create, modify and delete comments in bulk
  • BookBatchAdminSession: a session to create, modify and delete books in bulk
MethodgetCommentBatchAdminSession
Description

Gets the OsidSession associated with the bulk comment administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.commenting.batch.CommentBatchAdminSessiona CommentBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommentBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCommentBatchAdmin() is true.
MethodgetCommentBatchAdminSessionForBook
Description

Gets the OsidSession associated with the bulk comment administration service for the given book.

Parametersosid.id.IdbookIdthe Id of the Book
osid.proxy.Proxyproxya proxy
Returnosid.commenting.batch.CommentBatchAdminSessiona CommentBatchAdminSession
ErrorsNOT_FOUNDno Book found by the given Id
NULL_ARGUMENT bookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommentBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommentBatchAdmin() and supportsVisibleFederation() are true
MethodgetBookBatchAdminSession
Description

Gets the OsidSession associated with the bulk book administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.commenting.batch.BookBatchAdminSessiona BookBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBookBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBookBatchAdmin() is true.