org.osid.commenting

Interface CommentingManager

All Superinterfaces:

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

public interface CommentingManager
extends OsidManager, CommentingProfile

The commenting manager provides access to commenting sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• CommentLookupSession: a session to lookup comments
• RatingLookupSession: a session to lookup comments
• CommentQuerySession: a session to query comments
• CommentSearchSession: a session to search comments
• CommentAdminSession: a session to manage comments
• CommentNotificationSession: a session to subscribe to notifications of comment changes
• CommentBookSession: a session for looking up comment and book mappings
• CommentBookAssignmentSession: a session for managing comment and book mappings
• CommentSmartBookSession: a session to manage dynamic comment books
• BookLookupSession: a session to retrieve books
• BookQuerySession: a session to query books
• BookSearchSession: a session to search for books
• BookAdminSession: a session to create, update and delete books
• BookNotificationSession: a session to receive notifications for changes in books
• BookHierarchyTraversalSession: a session to traverse hierarchies of books
• BookHierarchyDesignSession: a session to manage hierarchies of books

The commenting manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Methods

Modifier and Type	Method and Description
BookAdminSession	getBookAdminSession() Gets the OsidSession associated with the book administrative service.
BookHierarchyDesignSession	getBookHierarchyDesignSession() Gets the OsidSession associated with the book hierarchy design service.
BookHierarchySession	getBookHierarchySession() Gets the OsidSession associated with the book hierarchy service.
BookLookupSession	getBookLookupSession() Gets the OsidSession associated with the book lookup service.
BookNotificationSession	getBookNotificationSession(BookReceiver bookReceiver) Gets the OsidSession associated with the book notification service.
BookQuerySession	getBookQuerySession() Gets the OsidSession associated with the book query service.
BookSearchSession	getBookSearchSession() Gets the OsidSession associated with the book search service.
CommentAdminSession	getCommentAdminSession() Gets the OsidSession associated with the comment administration service.
CommentAdminSession	getCommentAdminSessionForBook(Id bookId) Gets the OsidSession associated with the comment administration service for the given book.
CommentBookAssignmentSession	getCommentBookAssignmentSession() Gets the session for assigning comment to book mappings.
CommentBookSession	getCommentBookSession() Gets the session for retrieving comment to book mappings.
CommentingBatchManager	getCommentingBatchManager() Gets a CommentingBatchManager.
CommentLookupSession	getCommentLookupSession() Gets the OsidSession associated with the comment lookup service.
CommentLookupSession	getCommentLookupSessionForBook(Id bookId) Gets the OsidSession associated with the comment lookup service for the given book.
CommentNotificationSession	getCommentNotificationSession(CommentReceiver commentReceiver) Gets the OsidSession associated with the comment notification service.
CommentNotificationSession	getCommentNotificationSessionForBook(CommentReceiver commentReceiver, Id bookId) Gets the OsidSession associated with the comment notification service for the given book.
CommentQuerySession	getCommentQuerySession() Gets the OsidSession associated with the comment query service.
CommentQuerySession	getCommentQuerySessionForBook(Id bookId) Gets the OsidSession associated with the comment query service for the given book.
CommentSearchSession	getCommentSearchSession() Gets the OsidSession associated with the comment search service.
CommentSearchSession	getCommentSearchSessionForBook(Id bookId) Gets the OsidSession associated with the comment search service for the given book.
CommentSmartBookSession	getCommentSmartBookSession(Id bookId) Gets the session associated with the comment smart book for the given book.
RatingLookupSession	getRatingLookupSession() Gets the OsidSession associated with the rating lookup service.
RatingLookupSession	getRatingLookupSessionForBook(Id bookId) Gets the OsidSession associated with the rating lookup 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.CommentingProfile

getBookRecordTypes, getBookSearchRecordTypes, getCommentRecordTypes, getCommentSearchRecordTypes, supportsBookAdmin, supportsBookHierarchy, supportsBookHierarchyDesign, supportsBookLookup, supportsBookNotification, supportsBookQuery, supportsBookRecordType, supportsBookSearch, supportsBookSearchRecordType, supportsCommentAdmin, supportsCommentBook, supportsCommentBookAssignment, supportsCommentingBatch, supportsCommentLookup, supportsCommentNotification, supportsCommentQuery, supportsCommentRecordType, supportsCommentSearch, supportsCommentSearchRecordType, supportsCommentSmartBook, supportsRatingLookup, 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

getCommentLookupSession

CommentLookupSession getCommentLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the comment lookup service.

Returns:

a CommentLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentLookup() is false

Compliance:

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

getCommentLookupSessionForBook

CommentLookupSession getCommentLookupSessionForBook(Id bookId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the comment lookup service for the given book.

Parameters:

bookId - the Id of the Book

Returns:

a CommentLookupSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentLookup() or supportsVisibleFederation() is false

Compliance:

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

getRatingLookupSession

RatingLookupSession getRatingLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the rating lookup service.

Returns:

a RatingLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRatingLookup() is false

Compliance:

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

getRatingLookupSessionForBook

RatingLookupSession getRatingLookupSessionForBook(Id bookId)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the rating lookup service for the given book.

Parameters:

bookId - the Id of the Book

Returns:

a RatingLookupSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRatingLookup() or supportsVisibleFederation() is false

Compliance:

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

getCommentQuerySession

CommentQuerySession getCommentQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the comment query service.

Returns:

a CommentQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentQuery() is false

Compliance:

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

getCommentQuerySessionForBook

CommentQuerySession getCommentQuerySessionForBook(Id bookId)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the comment query service for the given book.

Parameters:

bookId - the Id of the Book

Returns:

a CommentQuerySession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentQuery() or supportsVisibleFederation() is false

Compliance:

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

getCommentSearchSession

CommentSearchSession getCommentSearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the comment search service.

Returns:

a CommentSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentSearch() is false

Compliance:

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

getCommentSearchSessionForBook

CommentSearchSession getCommentSearchSessionForBook(Id bookId)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the comment search service for the given book.

Parameters:

bookId - the Id of the Book

Returns:

a CommentSearchSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentSearch() or supportsVisibleFederation() is false

Compliance:

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

getCommentAdminSession

CommentAdminSession getCommentAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the comment administration service.

Returns:

a CommentAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentAdmin() is false

Compliance:

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

getCommentAdminSessionForBook

CommentAdminSession getCommentAdminSessionForBook(Id bookId)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

bookId - the Id of the Book

Returns:

a CommentAdminSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCommentNotificationSession

CommentNotificationSession getCommentNotificationSession(CommentReceiver commentReceiver)
                                                         throws OperationFailedException

Gets the OsidSession associated with the comment notification service.

Parameters:

commentReceiver - the receiver

Returns:

a CommentNotificationSession

Throws:

NullArgumentException - commentReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentNotification() is false

Compliance:

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

getCommentNotificationSessionForBook

CommentNotificationSession getCommentNotificationSessionForBook(CommentReceiver commentReceiver,
                                                              Id bookId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the comment notification service for the given book.

Parameters:

commentReceiver - the receiver

bookId - the Id of the Book

Returns:

a CommentNotificationSession

Throws:

NotFoundException - no Book found by the given Id

NullArgumentException - commentReceiver or bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentNotification() or supportsVisibleFederation() is false

Compliance:

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

getCommentBookSession

CommentBookSession getCommentBookSession()
                                         throws OperationFailedException

Gets the session for retrieving comment to book mappings.

Returns:

a CommentBookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentBook() is false

Compliance:

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

getCommentBookAssignmentSession

CommentBookAssignmentSession getCommentBookAssignmentSession()
                                                             throws OperationFailedException

Gets the session for assigning comment to book mappings.

Returns:

a CommentBookAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentBookAssignment() is false

Compliance:

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

getCommentSmartBookSession

CommentSmartBookSession getCommentSmartBookSession(Id bookId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session associated with the comment smart book for the given book.

Parameters:

bookId - the Id of the book

Returns:

a CommentSmartBookSession

Throws:

NotFoundException - bookId not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentSmartBook() is false

Compliance:

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

getBookLookupSession

BookLookupSession getBookLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the book lookup service.

Returns:

a BookLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookLookup() is false

Compliance:

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

getBookQuerySession

BookQuerySession getBookQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the book query service.

Returns:

a BookQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookQuery() is false

Compliance:

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

getBookSearchSession

BookSearchSession getBookSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the book search service.

Returns:

a BookSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookSearch() is false

Compliance:

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

getBookAdminSession

BookAdminSession getBookAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the book administrative service.

Returns:

a BookAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookAdmin() is false

Compliance:

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

getBookNotificationSession

BookNotificationSession getBookNotificationSession(BookReceiver bookReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the book notification service.

Parameters:

bookReceiver - the receiver

Returns:

a BookNotificationSession

Throws:

NullArgumentException - bookReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBookNotification() is false

Compliance:

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

getBookHierarchySession

BookHierarchySession getBookHierarchySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the book hierarchy service.

Returns:

a BookHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookHierarchy() is false

Compliance:

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

getBookHierarchyDesignSession

BookHierarchyDesignSession getBookHierarchyDesignSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the book hierarchy design service.

Returns:

a BookHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBookHierarchyDesign() is false

Compliance:

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

getCommentingBatchManager

CommentingBatchManager getCommentingBatchManager()
                                                 throws OperationFailedException

Gets a CommentingBatchManager.

Returns:

a CommentingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentingBatch() is false

Compliance:

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