org.osid.commenting.batch

Interface CommentingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CommentingBatchProfile, OsidManager, OsidProfile, Sourceable

public interface CommentingBatchManager
extends OsidManager, CommentingBatchProfile

The commenting batch manager provides access to commenting batch sessions and provides interoperability tests for various aspects of this service. 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

Method Summary

Methods

Modifier and Type	Method and Description
BookBatchAdminSession	getBookBatchAdminSession() Gets the OsidSession associated with the bulk book administration service.
CommentBatchAdminSession	getCommentBatchAdminSession() Gets the OsidSession associated with the bulk comment administration service.
CommentBatchAdminSession	getCommentBatchAdminSessionForBook(Id bookId) Gets the OsidSession associated with the bulk comment administration service for the given book.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.commenting.batch.CommentingBatchProfile

supportsBookBatchAdmin, supportsCommentBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCommentBatchAdminSession

CommentBatchAdminSession getCommentBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk comment administration service.

Returns:

a CommentBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCommentBatchAdmin() is true.

getCommentBatchAdminSessionForBook

CommentBatchAdminSession getCommentBatchAdminSessionForBook(Id bookId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

bookId - the Id of the Book

Returns:

a CommentBatchAdminSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommentBatchAdmin() and supportsVisibleFederation() are true

getBookBatchAdminSession

BookBatchAdminSession getBookBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk book administration service.

Returns:

a BookBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBookBatchAdmin() is true.