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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CommentLookupSession getCommentLookupSession() throws OperationFailedException
OsidSession
associated with the comment lookup
service. CommentLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentLookup()
is false
optional
- This method must be implemented if
supportsCommentLookup()
is true.
CommentLookupSession getCommentLookupSessionForBook(Id bookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the comment lookup
service for the given book.bookId
- the Id
of the Book
CommentLookupSession
NotFoundException
- no Book
found by the
given Id
NullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCommentLookup()
and
supportsVisibleFederation()
are true
RatingLookupSession getRatingLookupSession() throws OperationFailedException
OsidSession
associated with the rating lookup
service. RatingLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRatingLookup()
is false
optional
- This method must be implemented if
supportsRatingLookup()
is true.
RatingLookupSession getRatingLookupSessionForBook(Id bookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the rating lookup
service for the given book.bookId
- the Id
of the Book
RatingLookupSession
NotFoundException
- no Book
found by the
given Id
NullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRatingLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRatingLookup()
and
supportsVisibleFederation()
are true
CommentQuerySession getCommentQuerySession() throws OperationFailedException
OsidSession
associated with the comment query
service. CommentQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentQuery()
is false
optional
- This method must be implemented if
supportsCommentQuery()
is true.
CommentQuerySession getCommentQuerySessionForBook(Id bookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the comment query
service for the given book.bookId
- the Id
of the Book
CommentQuerySession
NotFoundException
- no Book
found by the
given Id
NullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCommentQuery()
and
supportsVisibleFederation()
are true
CommentSearchSession getCommentSearchSession() throws OperationFailedException
OsidSession
associated with the comment search
service. CommentSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentSearch()
is false
optional
- This method must be implemented if
supportsCommentSearch()
is true.
CommentSearchSession getCommentSearchSessionForBook(Id bookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the comment search
service for the given book.bookId
- the Id
of the Book
CommentSearchSession
NotFoundException
- no Book
found by the
given Id
NullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCommentSearch()
and
supportsVisibleFederation()
are true
CommentAdminSession getCommentAdminSession() throws OperationFailedException
OsidSession
associated with the comment
administration service. CommentAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentAdmin()
is false
optional
- This method must be implemented if
supportsCommentAdmin()
is true.
CommentAdminSession getCommentAdminSessionForBook(Id bookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the comment
administration service for the given book.bookId
- the Id
of the Book
CommentAdminSession
NotFoundException
- no Book
found by the
given Id
NullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCommentAdmin()
and
supportsVisibleFederation()
are true
CommentNotificationSession getCommentNotificationSession(CommentReceiver commentReceiver) throws OperationFailedException
OsidSession
associated with the comment
notification service.commentReceiver
- the receiver CommentNotificationSession
NullArgumentException
- commentReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommentNotification()
is false
optional
- This method must be implemented if
supportsCommentNotification()
is true.
CommentNotificationSession getCommentNotificationSessionForBook(CommentReceiver commentReceiver, Id bookId) throws NotFoundException, OperationFailedException
OsidSession
associated with the comment
notification service for the given book.commentReceiver
- the receiverbookId
- the Id
of the Book
CommentNotificationSession
NotFoundException
- no Book
found by the
given Id
NullArgumentException
- commentReceiver
or bookId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommentNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCommentNotification()
and
supportsVisibleFederation()
are true
CommentBookSession getCommentBookSession() throws OperationFailedException
CommentBookSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCommentBook()
is false
optional
- This method must be implemented if
supportsCommentBook()
is true.
CommentBookAssignmentSession getCommentBookAssignmentSession() throws OperationFailedException
CommentBookAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommentBookAssignment()
is false
optional
- This method must be implemented if
supportsCommentBookAssignment()
is true.
CommentSmartBookSession getCommentSmartBookSession(Id bookId) throws NotFoundException, OperationFailedException
bookId
- the Id
of the book CommentSmartBookSession
NotFoundException
- bookId
not foundNullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommentSmartBook()
is false
optional
- This method must be implemented if
supportsCommentSmartBook()
is true.
BookLookupSession getBookLookupSession() throws OperationFailedException
OsidSession
associated with the book lookup
service. BookLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBookLookup()
is false
optional
- This method must be implemented if
supportsBookLookup()
is true.
BookQuerySession getBookQuerySession() throws OperationFailedException
OsidSession
associated with the book query
service. BookQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBookQuery()
is false
optional
- This method must be implemented if
supportsBookQuery()
is true.
BookSearchSession getBookSearchSession() throws OperationFailedException
OsidSession
associated with the book search
service. BookSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBookSearch()
is false
optional
- This method must be implemented if
supportsBookSearch()
is true.
BookAdminSession getBookAdminSession() throws OperationFailedException
OsidSession
associated with the book
administrative service. BookAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBookAdmin()
is false
optional
- This method must be implemented if
supportsBookAdmin()
is true.
BookNotificationSession getBookNotificationSession(BookReceiver bookReceiver) throws OperationFailedException
OsidSession
associated with the book
notification service.bookReceiver
- the receiver BookNotificationSession
NullArgumentException
- bookReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBookNotification()
is false
optional
- This method must be implemented if
supportsBookNotification()
is true.
BookHierarchySession getBookHierarchySession() throws OperationFailedException
OsidSession
associated with the book hierarchy
service. BookHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBookHierarchy()
is false
optional
- This method must be implemented if
supportsBookHierarchy()
is true.
BookHierarchyDesignSession getBookHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the book hierarchy
design service. BookHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBookHierarchyDesign()
is false
optional
- This method must be implemented if
supportsBookHierarchyDesign()
is true.
CommentingBatchManager getCommentingBatchManager() throws OperationFailedException
CommentingBatchManager.
CommentingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommentingBatch()
is false
optional
- This method must be implemented if
supportsCommentingBatch()
is true.