OSID - osid.provisioning.ProvisionAdminSession Service Interface Definition

Interface	osid.provisioning.ProvisionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Provisions.` 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 `Provision,` a `ProvisionForm` is requested using `getProvisionFormForCreate()` specifying the desired broker, provisionable, resource, and record `Types` or none if no record `Types` are needed. The returned `ProvisionForm` 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 `ProvisionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProvisionForm` corresponds to an attempted transaction. For updates, `ProvisionForms` are requested to the `Provision` `Id` that is to be updated using `getProvisionFormForUpdate().` Similarly, the `ProvisionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProvisionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Provisions.` To unmap a `Provision` from the current `Distributor,` the `ProvisionDistributorAssignmentSession` should be used. These delete operations attempt to remove the `Provision` itself thus removing it from all known `Distributor` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProvisions
Description	Tests if this user can create `Provisions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Provision` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Provision` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProvisionWithRecordTypes
Description	Tests if this user can create a single `Provision` using the desired record types. While `ProvisioningManager.getProvisionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Provision.` Providing an empty array tests if a `Provision` can be created with no records.
Parameters	`osid.type.Type[]`	`provisionRecordTypes`	array of provision record types
Return	`boolean`		`true` if `Provision` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`provisionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionFormForCreate
Description	Gets the provision form for creating new provisions. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`brokerId`	the `Id` for the broker
	`osid.id.Id`	`provisionableId`	the `Id` for the provisionable
	`osid.id.Id`	`resourceId`	the `Id` for the resource
	`osid.type.Type[]`	`provisionRecordTypes`	array of provision record types
Return	`osid.provisioning.ProvisionForm`		the provision form
Errors	NOT_FOUND		`brokerId, provisionableId,` or `resourceId` is not found
	NULL_ARGUMENT		`brokerId, provisionableId, resourceId,` or `provisionRecordTypes` 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	createProvision
Description	Creates a new `Provision.`
Parameters	`osid.provisioning.ProvisionForm`	`provisionForm`	the form for this `Provision`
Return	`osid.provisioning.Provision`		the new `Provision`
Errors	ILLEGAL_STATE		`provisionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`provisionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`provisionForm` did not originate from `getProvisionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProvisions
Description	Tests if this user can update `Provisions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Provision` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Provision` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionFormForUpdate
Description	Gets the provision form for updating an existing provision. A new provision form should be requested for each update transaction.
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision`
Return	`osid.provisioning.ProvisionForm`		the provision form
Errors	NOT_FOUND		`provisionId` is not found
	NULL_ARGUMENT		`provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProvision
Description	Updates an existing provision.
Parameters	`osid.provisioning.ProvisionForm`	`provisionForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`provisionForm` already used in an update transatcion
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`provisionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`provisionForm` did not originate from `getProvisionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProvisions
Description	Tests if this user can delete `Provisions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Provision` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Provision` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProvision
Description	Deletes a `Provision.`
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision` to remove
Errors	NOT_FOUND		`provisionId` not found
	NULL_ARGUMENT		`provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProvisionAliases
Description	Tests if this user can manage `Id` aliases for `Provisions.` 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 `Provision` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProvision
Description	Adds an `Id` to a `Provision` for the purpose of creating compatibility. The primary `Id` of the `Provision` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another provision, it is reassigned to the given provision `Id.`
Parameters	`osid.id.Id`	`provisionId`	the `Id` of a `Provision`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`provisionId` not found
	NULL_ARGUMENT		`provisionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.