OSID - osid.recipe.CookbookAdminSession Service Interface Definition

Interface	osid.recipe.CookbookAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.recipe.batch.CookbookBatchAdminSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session creates, updates, and deletes `Cookbooks` . 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 `Cookbook` , a `CookbookForm` is requested using `getCookbookFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CookbookForm` 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 `CookbookForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CookbookForm` corresponds to an attempted transaction. For updates, `CookbookForms` are requested to the `Cookbook` `Id` that is to be updated using `getCookbookFormForUpdate()` . Similarly, the `CookbookForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CookbookForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Cookbooks` . This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateCookbooks
Description	Tests if this user can create `Cookbooks` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Cookbook` 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 `Cookbook` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCookbookWithRecordTypes
Description	Tests if this user can create a single `Cookbook` using the desired record types. While `RecipeManager.getCookbookRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Cookbook` . Providing an empty array tests if an `Cookbook` can be created with no records.
Parameters	`osid.type.Type[]`	`cookbookRecordTypes`	array of cookbook types
Return	`boolean`		`true` if `Cookbook` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cookbookRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookFormForCreate
Description	Gets the cookbook form for creating new cookbooks. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`cookbookRecordTypes`	array of cookbook types
Return	`osid.recipe.CookbookForm`		the cookbook form
Errors	NULL_ARGUMENT		`cookbookRecordTypes` 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	createCookbook
Description	Creates a new `Cookbook` .
Parameters	`osid.recipe.CookbookForm`	`cookbookForm`	the form for this `Cookbook`
Return	`osid.recipe.Cookbook`		the new `Cookbook`
Errors	ILLEGAL_STATE		`cookbookForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`cookbookForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cookbookForm` did not originate from `getCookbookFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCookbooks
Description	Tests if this user can update `Cookbooks` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Cookbook` 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 `Cookbook` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookFormForUpdate
Description	Gets the cookbook form for updating an existing cookbook. A new cookbook form should be requested for each update transaction.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook`
Return	`osid.recipe.CookbookForm`		the cookbook form
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCookbook
Description	Updates an existing cookbook.
Parameters	`osid.recipe.CookbookForm`	`cookbookForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`cookbookForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`cookbookForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cookbookForm` did not originate from `getCookbookFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCookbooks
Description	Tests if this user can delete `Cookbooks` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Cookbook` 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 `Cookbook` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCookbook
Description	Deletes an `Cookbook` .
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` to remove
Errors	NOT_FOUND		`cookbookId` not found
	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCookbookAliases
Description	Tests if this user can manage `Id` aliases for `Cookbooks` . 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 `Cookbook` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCookbook
Description	Adds an `Id` to an `Cookbook` for the purpose of creating compatibility. The primary `Id` of the `Cookbook` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another cookbook, it is reassigned to the given cookbook `Id` .
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of an `Cookbook`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`cookbookId` not found
	NULL_ARGUMENT		`cookbookId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.