OSID - osid.commenting.BookAdminSession Service Interface Definition

Interface	osid.commenting.BookAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Books.` 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 `Book,` a `BookForm` is requested using `getBookFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BookForm` 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 `BookForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BookForm` corresponds to an attempted transaction. For updates, `BookForms` are requested to the `Book` `Id` that is to be updated using `getBookFormForUpdate().` Similarly, the `BookForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BookForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Books.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateBooks
Description	Tests if this user can create `Books.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Book` 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 `Book` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBookWithRecordTypes
Description	Tests if this user can create a single `Book` using the desired record types. While `CommentingManager.getBookRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Book.` Providing an empty array tests if a `Book` can be created with no records.
Parameters	`osid.type.Type[]`	`bookRecordTypes`	array of book record types
Return	`boolean`		`true` if `Book` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`bookRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBookFormForCreate
Description	Gets the book form for creating new books. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`bookRecordTypes`	array of book record types
Return	`osid.commenting.BookForm`		the book form
Errors	NULL_ARGUMENT		`bookRecordTypes` 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	createBook
Description	Creates a new `Book.`
Parameters	`osid.commenting.BookForm`	`bookForm`	the form for this `Book`
Return	`osid.commenting.Book`		the new `Book`
Errors	ILLEGAL_STATE		`bookForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`bookForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bookForm` did not originte from `getBookFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBooks
Description	Tests if this user can update `Books.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Book` 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 `Book` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBookFormForUpdate
Description	Gets the book form for updating an existing book. A new book form should be requested for each update transaction.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book`
Return	`osid.commenting.BookForm`		the book form
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	updateBook
Description	Updates an existing book.
Parameters	`osid.commenting.BookForm`	`bookForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`bookForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`bookForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bookForm` did not originte from `getBookFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBooks
Description	Tests if this user can delete `Books` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Book` 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 `Book` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBook
Description	Deletes a `Book.`
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` to remove
Errors	NOT_FOUND		`bookId` 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	canManageBookAliases
Description	Tests if this user can manage `Id` aliases for `Books.` 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 `Book` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBook
Description	Adds an `Id` to a `Book` for the purpose of creating compatibility. The primary `Id` of the `Book` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another book, it is reassigned to the given book `Id.`
Parameters	`osid.id.Id`	`bookId`	the `Id` of a `Book`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`bookId` not found
	NULL_ARGUMENT		`bookId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.