OSID - osid.commenting.CommentBookAssignmentSession Service Interface Definition

Interface	osid.commenting.CommentBookAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	This session provides methods to re-assign `Comments` to `Books` . A `Comment` may map to multiple `Books` and removing the last reference to a `Comment` is the equivalent of deleting it. Each `Book` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Comment` to another `Book` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignComments
Description	Tests if this user can alter comment/book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignCommentsToBook
Description	Tests if this user can alter comment/book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`bookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableBookIds
Description	Gets a list of books including and under the given book node in which any comment can be assigned.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.id.IdList`		list of assignable book `Ids`
Errors	NULL_ARGUMENT		`bookId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableBookIdsForComment
Description	Gets a list of books including and under the given book node in which a specific comment can be assigned.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment`
Return	`osid.id.IdList`		list of assignable book `Ids`
Errors	NULL_ARGUMENT		`bookId` or `commentId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCommentToBook
Description	Adds an existing `Comment` to a `Book` .
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment`
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Errors	ALREADY_EXISTS		`commentId` is already assigned to `bookId`
	NOT_FOUND		`commentId` or `bookId` not found
	NULL_ARGUMENT		`commentId` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCommentFromBook
Description	Removes a `Comment` from a `Book` .
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment`
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Errors	NOT_FOUND		`commentId` or `bookId` not found or `commentId` not assigned to `bookId`
	NULL_ARGUMENT		`commentId` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCommentToBook
Description	Moves a `Credit` from one `Book` to another. Mappings to other `Books` are unaffected.
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment`
	`osid.id.Id`	`fromBookId`	the `Id` of the current `Book`
	`osid.id.Id`	`toBookId`	the `Id` of the destination `Book`
Errors	ALREADY_EXISTS		`commentId` already assigned to `toBookId`
	NOT_FOUND		`commentId, fromBookId` , or `toBookId` not found or `comment` not mapped to `fromBookId`
	NULL_ARGUMENT		`commentId, bookIdId` , or `toBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.