OSID - osid.commenting.CommentingManager Service Interface Definition

Interface	osid.commenting.CommentingManager
Implements	`osid.OsidManager`
Implements	`osid.commenting.CommentingProfile`
Description	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	getCommentLookupSession
Description	Gets the `OsidSession` associated with the comment lookup service.
Return	`osid.commenting.CommentLookupSession`		a `CommentLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentLookup()` is `true.`
Method	getCommentLookupSessionForBook
Description	Gets the `OsidSession` associated with the comment lookup service for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.CommentLookupSession`		a `CommentLookupSession`
Errors	NOT_FOUND		no `Book` found by the given `Id`
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentLookup()` and `supportsVisibleFederation()` are `true`
Method	getRatingLookupSession
Description	Gets the `OsidSession` associated with the rating lookup service.
Return	`osid.commenting.RatingLookupSession`		a `RatingLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRatingLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRatingLookup()` is `true.`
Method	getRatingLookupSessionForBook
Description	Gets the `OsidSession` associated with the rating lookup service for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.RatingLookupSession`		a `RatingLookupSession`
Errors	NOT_FOUND		no `Book` found by the given `Id`
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRatingLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRatingLookup()` and `supportsVisibleFederation()` are `true`
Method	getCommentQuerySession
Description	Gets the `OsidSession` associated with the comment query service.
Return	`osid.commenting.CommentQuerySession`		a `CommentQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentQuery()` is `true.`
Method	getCommentQuerySessionForBook
Description	Gets the `OsidSession` associated with the comment query service for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.CommentQuerySession`		a `CommentQuerySession`
Errors	NOT_FOUND		no `Book` found by the given `Id`
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentQuery()` and `supportsVisibleFederation()` are `true`
Method	getCommentSearchSession
Description	Gets the `OsidSession` associated with the comment search service.
Return	`osid.commenting.CommentSearchSession`		a `CommentSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentSearch()` is `true.`
Method	getCommentSearchSessionForBook
Description	Gets the `OsidSession` associated with the comment search service for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.CommentSearchSession`		a `CommentSearchSession`
Errors	NOT_FOUND		no `Book` found by the given `Id`
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentSearch()` and `supportsVisibleFederation()` are `true`
Method	getCommentAdminSession
Description	Gets the `OsidSession` associated with the comment administration service.
Return	`osid.commenting.CommentAdminSession`		a `CommentAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentAdmin()` is `true.`
Method	getCommentAdminSessionForBook
Description	Gets the `OsidSession` associated with the comment administration service for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.CommentAdminSession`		a `CommentAdminSession`
Errors	NOT_FOUND		no `Book` found by the given `Id`
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentAdmin()` and `supportsVisibleFederation()` are `true`
Method	getCommentNotificationSession
Description	Gets the `OsidSession` associated with the comment notification service.
Parameters	`osid.commenting.CommentReceiver`	`commentReceiver`	the receiver
Return	`osid.commenting.CommentNotificationSession`		a `CommentNotificationSession`
Errors	NULL_ARGUMENT		`commentReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentNotification()` is `true.`
Method	getCommentNotificationSessionForBook
Description	Gets the `OsidSession` associated with the comment notification service for the given book.
Parameters	`osid.commenting.CommentReceiver`	`commentReceiver`	the receiver
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.CommentNotificationSession`		a `CommentNotificationSession`
Errors	NOT_FOUND		no `Book` found by the given `Id`
	NULL_ARGUMENT		`commentReceiver` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentNotification()` and `supportsVisibleFederation()` are `true`
Method	getCommentBookSession
Description	Gets the session for retrieving comment to book mappings.
Return	`osid.commenting.CommentBookSession`		a `CommentBookSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentBook()` is `true.`
Method	getCommentBookAssignmentSession
Description	Gets the session for assigning comment to book mappings.
Return	`osid.commenting.CommentBookAssignmentSession`		a `CommentBookAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentBookAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentBookAssignment()` is `true.`
Method	getCommentSmartBookSession
Description	Gets the session associated with the comment smart book for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the book
Return	`osid.commenting.CommentSmartBookSession`		a `CommentSmartBookSession`
Errors	NOT_FOUND		`bookId` not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCommentSmartBook()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentSmartBook()` is `true.`
Method	getBookLookupSession
Description	Gets the `OsidSession` associated with the book lookup service.
Return	`osid.commenting.BookLookupSession`		a `BookLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBookLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookLookup()` is `true.`
Method	getBookQuerySession
Description	Gets the `OsidSession` associated with the book query service.
Return	`osid.commenting.BookQuerySession`		a `BookQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookQuery()` is `true.`
Method	getBookSearchSession
Description	Gets the `OsidSession` associated with the book search service.
Return	`osid.commenting.BookSearchSession`		a `BookSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBookSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookSearch()` is `true.`
Method	getBookAdminSession
Description	Gets the `OsidSession` associated with the book administrative service.
Return	`osid.commenting.BookAdminSession`		a `BookAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBookAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookAdmin()` is `true.`
Method	getBookNotificationSession
Description	Gets the `OsidSession` associated with the book notification service.
Parameters	`osid.commenting.BookReceiver`	`bookReceiver`	the receiver
Return	`osid.commenting.BookNotificationSession`		a `BookNotificationSession`
Errors	NULL_ARGUMENT		`bookReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBookNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookNotification()` is `true.`
Method	getBookHierarchySession
Description	Gets the `OsidSession` associated with the book hierarchy service.
Return	`osid.commenting.BookHierarchySession`		a `BookHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBookHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookHierarchy()` is `true.`
Method	getBookHierarchyDesignSession
Description	Gets the `OsidSession` associated with the book hierarchy design service.
Return	`osid.commenting.BookHierarchyDesignSession`		a `BookHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBookHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookHierarchyDesign()` is `true.`
Method	getCommentingBatchManager
Description	Gets a `CommentingBatchManager.`
Return	`osid.commenting.batch.CommentingBatchManager`		a `CommentingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsCommentingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentingBatch()` is `true.`