org.osid.commenting

Interface CommentingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CommentingProfile, OsidProfile, 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

Methods

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