org.osid.commenting.batch

Interface CommentingBatchProxyManager

All Superinterfaces:

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

public interface CommentingBatchProxyManager
extends OsidProxyManager, CommentingBatchProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk comment administration service.

Parameters:

proxy - a proxy

Returns:

a CommentBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

bookId - the Id of the Book

proxy - a proxy

Returns:

a CommentBatchAdminSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk book administration service.

Parameters:

proxy - a proxy

Returns:

a BookBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBookBatchAdmin() is false

Compliance:

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