Interface CommentingManager

All Superinterfaces:

AutoCloseable, Closeable, CommentingProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getBookRecordTypes()	Gets the supported Book record types.
TypeList	getBookSearchRecordTypes()	Gets the supported book search record types.
TypeList	getCommentRecordTypes()	Gets the supported Comment record types.
TypeList	getCommentSearchRecordTypes()	Gets the supported comment search record types.
boolean	supportsBookAdmin()	Tests for the availability of a book administrative service for creating and deleting books.
boolean	supportsBookHierarchy()	Tests for the availability of a book hierarchy traversal service.
boolean	supportsBookHierarchyDesign()	Tests for the availability of a book hierarchy design service.
boolean	supportsBookLookup()	Tests for the availability of a book lookup service.
boolean	supportsBookNotification()	Tests for the availability of a book notification service.
boolean	supportsBookQuery()	Tests if querying books is available.
boolean	supportsBookRecordType(Type bookRecordType)	Tests if the given Book record type is supported.
boolean	supportsBookSearch()	Tests if searching for books is available.
boolean	supportsBookSearchRecordType(Type bookSearchRecordType)	Tests if the given book search record type is supported.
boolean	supportsCommentAdmin()	Tests if managing comments is available.
boolean	supportsCommentBook()	Tests if a comment to book lookup session is available.
boolean	supportsCommentBookAssignment()	Tests if a comment to book assignment session is available.
boolean	supportsCommentingBatch()	Tests for the availability of a commenting batch service.
boolean	supportsCommentLookup()	Tests for the availability of a comment lookup service.
boolean	supportsCommentNotification()	Tests if comment notification is available.
boolean	supportsCommentQuery()	Tests if querying comments is available.
boolean	supportsCommentRecordType(Type commentRecordType)	Tests if the given Comment record type is supported.
boolean	supportsCommentSearch()	Tests if searching for comments is available.
boolean	supportsCommentSearchRecordType(Type commentSearchRecordType)	Tests if the given comment search record type is supported.
boolean	supportsCommentSmartBook()	Tests if a comment smart booking session is available.
boolean	supportsRatingLookup()	Tests for the availability of a rating lookup service.
boolean	supportsVisibleFederation()	Tests if any book federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsCommentLookup()} is {@code 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 {@code supportsCommentLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRatingLookup()} is {@code 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 {@code supportsRatingLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCommentQuery()} is {@code 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 {@code supportsCommentQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCommentSearch()} is {@code 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 {@code supportsCommentSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCommentAdmin()} is {@code 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 {@code supportsCommentAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCommentNotification()} is {@code 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 {@code supportsCommentNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCommentBook()} is {@code 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 {@code supportsCommentBookAssignment()} is {@code 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 {@code supportsCommentSmartBook()} is {@code 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 {@code supportsBookLookup()} is {@code 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 {@code supportsBookQuery()} is {@code 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 {@code supportsBookSearch()} is {@code 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 {@code supportsBookAdmin()} is {@code 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 {@code supportsBookNotification()} is {@code 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 {@code supportsBookHierarchy()} is {@code 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 {@code supportsBookHierarchyDesign()} is {@code 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 {@code supportsCommentingBatch()} is {@code true} .