OSID - osid.commenting.CommentBookSession Service Interface Definition

Interface	osid.commenting.CommentBookSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `Comment` to `Book` mappings. A `Comment` may appear in multiple `Books.` Each `Book` may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupCommentBookMappings
Description	Tests if this user can perform lookups of comment/book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED.` This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBookView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBookView
Description	A complete view of the `Comment` and `Book` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getCommentIdsByBook
Description	Gets the list of Comment Ids associated with a `Book.`
Parameters	`osid.id.Id`	`bookId`	`Id` of a `Book.`
Return	`osid.id.IdList`		list of related comment `Ids`
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommentsByBook
Description	Gets the list of `Comments` associated with a `Book.`
Parameters	`osid.id.Id`	`bookId`	`Id` of a `Book`
Return	`osid.commenting.CommentList`		list of related comments
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommentIdsByBooks
Description	Gets the list of `Comment Ids` corresponding to a list of `Book` objects.
Parameters	`osid.id.IdList`	`bookIds`	list of book `Ids`
Return	`osid.id.IdList`		list of comment `Ids`
Errors	NULL_ARGUMENT		`bookIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommentsByBooks
Description	Gets the list of `Comments` corresponding to a list of `Books.`
Parameters	`osid.id.IdList`	`bookIds`	list of book `Ids`
Return	`osid.commenting.CommentList`		list of comments
Errors	NULL_ARGUMENT		`bookIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBookIdsByComment
Description	Gets the list of `Book` `Ids` mapped to a `Comment.`
Parameters	`osid.id.Id`	`commentId`	`Id` of a `Comment`
Return	`osid.id.IdList`		list of book `Ids`
Errors	NOT_FOUND		`commentId` is not found
	NULL_ARGUMENT		`commentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBooksByComment
Description	Gets the list of `Book` objects mapped to a `Comment.`
Parameters	`osid.id.Id`	`commentId`	`Id` of a `Comment`
Return	`osid.commenting.BookList`		list of books
Errors	NOT_FOUND		`commentId` is not found
	NULL_ARGUMENT		`commentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.