Interface CommentingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CommentingProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CommentingProxyManager
extends OsidProxyManager, CommentingProfile

The commenting manager provides access to commenting sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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(Proxy proxy)	Gets the OsidSession associated with the book administrative service.
BookHierarchyDesignSession	getBookHierarchyDesignSession(Proxy proxy)	Gets the OsidSession associated with the book hierarchy design service.
BookHierarchySession	getBookHierarchySession(Proxy proxy)	Gets the OsidSession associated with the book hierarchy service.
BookLookupSession	getBookLookupSession(Proxy proxy)	Gets the OsidSession associated with the book lookup service.
BookNotificationSession	getBookNotificationSession(BookReceiver bookReceiver, Proxy proxy)	Gets the OsidSession associated with the book notification service.
BookQuerySession	getBookQuerySession(Proxy proxy)	Gets the OsidSession associated with the book query service.
BookSearchSession	getBookSearchSession(Proxy proxy)	Gets the OsidSession associated with the book search service.
CommentAdminSession	getCommentAdminSession(Proxy proxy)	Gets the OsidSession associated with the comment administration service.
CommentAdminSession	getCommentAdminSessionForBook(Id bookId, Proxy proxy)	Gets the OsidSession associated with the comment administration service for the given book.
CommentBookAssignmentSession	getCommentBookAssignmentSession(Proxy proxy)	Gets the session for assigning comment to book mappings.
CommentBookSession	getCommentBookSession(Proxy proxy)	Gets the session for retrieving comment to book mappings.
CommentingBatchProxyManager	getCommentingBatchProxyManager()	Gets a CommentingBatchProxyManager.
CommentLookupSession	getCommentLookupSession(Proxy proxy)	Gets the OsidSession associated with the comment lookup service.
CommentLookupSession	getCommentLookupSessionForBook(Id bookId, Proxy proxy)	Gets the OsidSession associated with the comment lookup service for the given book.
CommentNotificationSession	getCommentNotificationSession(CommentReceiver commentReceiver, Proxy proxy)	Gets the OsidSession associated with the comment notification service.
CommentNotificationSession	getCommentNotificationSessionForBook(CommentReceiver commentReceiver, Id bookId, Proxy proxy)	Gets the OsidSession associated with the comment notification service for the given book.
CommentQuerySession	getCommentQuerySession(Proxy proxy)	Gets the OsidSession associated with the comment query service.
CommentQuerySession	getCommentQuerySessionForBook(Id bookId, Proxy proxy)	Gets the OsidSession associated with the comment query service for the given book.
CommentSearchSession	getCommentSearchSession(Proxy proxy)	Gets the OsidSession associated with the comment search service.
CommentSearchSession	getCommentSearchSessionForBook(Id bookId, Proxy proxy)	Gets the OsidSession associated with the comment search service for the given book.
CommentSmartBookSession	getCommentSmartBookSession(Id bookId, Proxy proxy)	Gets the session for managing dynamic comment books for the given book.
RatingLookupSession	getRatingLookupSession(Proxy proxy)	Gets the OsidSession associated with the rating lookup service.
RatingLookupSession	getRatingLookupSessionForBook(Id bookId, Proxy proxy)	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 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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

Gets the OsidSession associated with the comment lookup service.

Parameters:

proxy - a proxy

Returns:

a CommentLookupSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

bookId - the Id of the Book

proxy - a proxy

Returns:

a CommentLookupSession

Throws:

NotFoundException - no Book found by the given Id

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

Gets the OsidSession associated with the rating lookup service.

Parameters:

proxy - a proxy

Returns:

a RatingLookupSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

bookId - the Id of the Book

proxy - a proxy

Returns:

a RatingLookupSession

Throws:

NotFoundException - no Book found by the given Id

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

Gets the OsidSession associated with the comment query service.

Parameters:

proxy - a proxy

Returns:

a CommentQuerySession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

bookId - the Id of the Book

proxy - a proxy

Returns:

a CommentQuerySession

Throws:

NotFoundException - no Comment found by the given Id

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

Gets the OsidSession associated with the comment search service.

Parameters:

proxy - a proxy

Returns:

a CommentSearchSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

bookId - the Id of the Book

proxy - a proxy

Returns:

a CommentSearchSession

Throws:

NotFoundException - no Comment found by the given Id

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

Gets the OsidSession associated with the comment administration service.

Parameters:

proxy - a proxy

Returns:

a CommentAdminSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

bookId - the Id of the Book

proxy - a proxy

Returns:

a CommentAdminSession

Throws:

NotFoundException - no Comment found by the given Id

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

Gets the OsidSession associated with the comment notification service.

Parameters:

commentReceiver - the receiver

proxy - a proxy

Returns:

a CommentNotificationSession

Throws:

NullArgumentException - commentReceiver or proxy 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,
 Proxy proxy)
                                                         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

proxy - a proxy

Returns:

a CommentNotificationSession

Throws:

NotFoundException - no Comment found by the given Id

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

Gets the session for retrieving comment to book mappings.

Parameters:

proxy - a proxy

Returns:

a CommentBookSession

Throws:

NullArgumentException - proxy is null

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

Gets the session for assigning comment to book mappings.

Parameters:

proxy - a proxy

Returns:

a CommentBookAssignmentSession

Throws:

NullArgumentException - proxy is null

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

Gets the session for managing dynamic comment books for the given book.

Parameters:

bookId - the Id of a book

proxy - a proxy

Returns:

bookId not found

Throws:

NotFoundException - bookId or proxy is null

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

Gets the OsidSession associated with the book lookup service.

Parameters:

proxy - a proxy

Returns:

a BookLookupSession

Throws:

NullArgumentException - proxy is null

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

Gets the OsidSession associated with the book query service.

Parameters:

proxy - a proxy

Returns:

a BookQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBookQueryh() is false

Compliance:

optional - This method must be implemented if {@code supportsBookQuery()} is {@code true}.

getBookSearchSession

BookSearchSession getBookSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the book search service.

Parameters:

proxy - a proxy

Returns:

a BookSearchSession

Throws:

NullArgumentException - proxy is null

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

Gets the OsidSession associated with the book administrative service.

Parameters:

proxy - a proxy

Returns:

a BookAdminSession

Throws:

NullArgumentException - proxy is null

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

Gets the OsidSession associated with the book notification service.

Parameters:

bookReceiver - the receiver

proxy - a proxy

Returns:

a BookNotificationSession

Throws:

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

Gets the OsidSession associated with the book hierarchy service.

Parameters:

proxy - a proxy

Returns:

a BookHierarchySession

Throws:

NullArgumentException - proxy is null

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

Gets the OsidSession associated with the book hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a BookHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBookHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsBookHierarchyDesign()} is {@code true}.

getCommentingBatchProxyManager

CommentingBatchProxyManager getCommentingBatchProxyManager()
                                                    throws OperationFailedException

Gets a CommentingBatchProxyManager.

Returns:

a CommentingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommentingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsCommentingBatch()} is {@code true}.