OSID - osid.commenting.CommentAdminSession Service Interface Definition

Interface	osid.commenting.CommentAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.commenting.batch.CommentBatchAdminSession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	This session creates, updates, and deletes `Comments`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Comment`, a `CommentForm` is requested using `getCommentFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `CommentForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `CommentForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CommentForm` corresponds to an attempted transaction. For updates, `CommentForms` are requested to the `Comment` `Id` that is to be updated using `getCommentFormForUpdate()`. Similarly, the `CommentForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CommentForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Comments`. To unmap a `Comment` from the current `Book`, the `CommentBookAssignmentSession` should be used. These delete operations attempt to remove the `Comment` itself thus removing it from all known `Book` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBookId
Description	Gets the `Book` `Id` associated with this session.
Return	`osid.id.Id`		the `Book Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBook
Description	Gets the `Book` associated with this session.
Return	`osid.commenting.Book`		the book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateComments
Description	Tests if this user can create comments. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Comment` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Comment` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommentWithRecordTypes
Description	Tests if this user can create a single `Comment` using the desired record types. While `CommentingManager.getCommentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Comment`. Providing an empty array tests if a `Comment` can be created with no records.
Parameters	`osid.type.Type[]`	`commentRecordTypes`	array of comment record types
Return	`boolean`		`true` if `Comment` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`commentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCommentFormForCreate
Description	Gets the comment form for creating new comments. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`referenceId`	the `Id` for the reference object
Parameters	`osid.type.Type[]`	`commentRecordTypes`	array of comment record types
Return	`osid.commenting.CommentForm`		the comment form
Errors	NULL_ARGUMENT		`referenceId or commentRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createComment
Description	Creates a new `Comment`.
Parameters	`osid.commenting.CommentForm`	`commentForm`	the form for this `Comment`
Return	`osid.commenting.Comment`		the new `Comment`
Errors	ILLEGAL_STATE		`commentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`commentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commentForm` did not originate from `getCommentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateComments
Description	Tests if this user can update comments. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Comment` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Comment` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommentFormForUpdate
Description	Gets the comment form for updating an existing comment. A new comment form should be requested for each update transaction.
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment`
Return	`osid.commenting.CommentForm`		the comment form
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	updateComment
Description	Updates an existing comment.
Parameters	`osid.commenting.CommentForm`	`commentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`commentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`commentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commentForm` did not originate from `getCommentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteComments
Description	Tests if this user can delete comments. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Comment` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Comment` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteComment
Description	Deletes a `Comment`.
Parameters	`osid.id.Id`	`commentId`	the `Id` of the `Comment` to remove
Errors	NOT_FOUND		`commentId` 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	canManageCommentAliases
Description	Tests if this user can manage `Id` aliases for `Comnents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Comment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasComment
Description	Adds an `Id` to a `Comment` for the purpose of creating compatibility. The primary `Id` of the `Comment` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another comment, it is reassigned to the given comment `Id`.
Parameters	`osid.id.Id`	`commentId`	the `Id` of a `Comment`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`commentId` not found
	NULL_ARGUMENT		`commentId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.