OSID - osid.recipe.ProcedureAdminSession Service Interface Definition

Interface	osid.recipe.ProcedureAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Procedures.` 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 `Procedure,` a `ProcedureForm` is requested using `getProcedureFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProcedureForm` 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 `ProcedureForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProcedureForm` corresponds to an attempted transaction. For updates, `ProcedureForms` are requested to the `Procedure` `Id` that is to be updated using `getProcedureFormForUpdate().` Similarly, the `ProcedureForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProcedureForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Procedures.` To unmap a `Procedure` from the current `Cookbook,` the `ProcedureCookbookAssignmentSession` should be used. These delete operations attempt to remove the `Procedure` itself thus removing it from all known `Cookbook` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCookbookId
Description	Gets the `Cookbook` `Id` associated with this session.
Return	`osid.id.Id`		the `Cookbook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbook
Description	Gets the `Cookbook` associated with this session.
Return	`osid.recipe.Cookbook`		the cookbook
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProcedures
Description	Tests if this user can create procedures. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Procedure` 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 `Procedure` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProcedureWithRecordTypes
Description	Tests if this user can create a single `Procedure` using the desired record types. While `RecipeManager.getProcedureRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Procedure.` Providing an empty array tests if a `Procedure` can be created with no records.
Parameters	`osid.type.Type[]`	`procedureRecordTypes`	array of procedure record types
Return	`boolean`		`true` if `Procedure` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`procedureRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureFormForCreate
Description	Gets the procedure form for creating new procedures. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`procedureRecordTypes`	array of procedure record types
Return	`osid.recipe.ProcedureForm`		the procedure form
Errors	NULL_ARGUMENT		`procedureRecordTypes` 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	createProcedure
Description	Creates a new `Procedure.`
Parameters	`osid.recipe.ProcedureForm`	`procedureForm`	the form for this `Procedure`
Return	`osid.recipe.Procedure`		the new `Procedure`
Errors	ILLEGAL_STATE		`procedureForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`procedureForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`procedureForm` did not originate from `getProcedureFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProcedures
Description	Tests if this user can update procedures. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Procedure` 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 `Procedure` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProcedure
Description	Tests if this user can update a specified `Procedure.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the `Procedure` 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.
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure`
Return	`boolean`		`false` if procedure modification is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`procedureId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `procedureId` is not found, then it is acceptable to return false to indicate the lack of an update available.
Method	getProcedureFormForUpdate
Description	Gets the procedure form for updating an existing procedure. A new procedure form should be requested for each update transaction.
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure`
Return	`osid.recipe.ProcedureForm`		the procedure form
Errors	NOT_FOUND		`procedureId` is not found
	NULL_ARGUMENT		`procedureId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProcedure
Description	Updates an existing procedure.
Parameters	`osid.recipe.ProcedureForm`	`procedureForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`procedureForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`procedureId` or `procedureForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`procedureForm` did not originate from `getProcedureFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProcedures
Description	Tests if this user can delete procedures. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Procedure` 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 `Procedure` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProcedure
Description	Tests if this user can delete a specified `Procedure.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `Procedure` 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.
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure`
Return	`boolean`		`false` if deletion of this `Procedure` is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`procedureId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `procedureId` is not found, then it is acceptable to return false to indicate the lack of a delete available.
Method	deleteProcedure
Description	Deletes a `Procedure.`
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure` to remove
Errors	NOT_FOUND		`procedureId` not found
	NULL_ARGUMENT		`procedureId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	deleteProcedures
Description	Deletes all `Procedures` in this `Cookbook.`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProcedureAliases
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 `Procedure` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProcedure
Description	Adds an `Id` to a `Procedure` for the purpose of creating compatibility. The primary `Id` of the `Procedure` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another procedure, it is reassigned to the given procedure `Id.`
Parameters	`osid.id.Id`	`procedureId`	the `Id` of a `Procedure`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`procedureId` not found
	NULL_ARGUMENT		`procedureId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.