OSID - osid.provisioning.rules.PoolProcessorAdminSession Service Interface Definition

Interface	osid.provisioning.rules.PoolProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session creates, updates, and deletes `PoolProcessors`. 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 `PoolProcessor`, a `PoolProcessorForm` is requested using `getPoolProcessorFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PoolProcessorForm` 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 `PoolProcessorForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PoolProcessorForm` corresponds to an attempted transaction. For updates, `PoolProcessorForms` are requested to the `PoolProcessor` `Id` that is to be updated using `getPoolProcessorFormForUpdate()`. Similarly, the `PoolProcessorForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PoolProcessorForm` can only be used once for a successful update and cannot be reused. The delete operations delete `PoolProcessors`. To unmap a `PoolProcessor` from the current `Distributor`, the `PoolProcessorDistributorAssignmentSession` should be used. These delete operations attempt to remove the `PoolProcessor` 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	canCreatePoolProcessors
Description	Tests if this user can create `PoolProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `PoolProcessor` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `PoolProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePoolProcessorWithRecordTypes
Description	Tests if this user can create a single `PoolProcessor` using the desired record types. While `ProvisioningRulesManager.getPoolProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `PoolProcessor`. Providing an empty array tests if a `PoolProcessor can be cre` ated with no records.
Parameters	`osid.type.Type[]`	`poolProcessorRecordTypes`	array of pool processor record types
Return	`boolean`		`true` if `PoolProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`poolProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorFormForCreate
Description	Gets the pool processor form for creating new pool processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`poolProcessorRecordTypes`	array of pool processor record types
Return	`osid.provisioning.rules.PoolProcessorForm`		the pool processor form
Errors	NULL_ARGUMENT		`poolProcessorRecordTypes` 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	createPoolProcessor
Description	Creates a new `PoolProcessor`.
Parameters	`osid.provisioning.rules.PoolProcessorForm`	`poolProcessorForm`	the form for this `PoolProcessor`
Return	`osid.provisioning.rules.PoolProcessor`		the new `PoolProcessor`
Errors	ILLEGAL_STATE		`poolProcessorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`poolProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorForm` did not originate from `getPoolProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePoolProcessors
Description	Tests if this user can update `PoolProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `PoolProcessor` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `PoolProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorFormForUpdate
Description	Gets the pool processor form for updating an existing pool processor. A new pool processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor`
Return	`osid.provisioning.rules.PoolProcessorForm`		the pool processor form
Errors	NOT_FOUND		`poolProcessorId` is not found
	NULL_ARGUMENT		`poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePoolProcessor
Description	Updates an existing pool processor.
Parameters	`osid.provisioning.rules.PoolProcessorForm`	`poolProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`poolProcessorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`poolProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorForm` did not originate from `getPoolProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePoolProcessors
Description	Tests if this user can delete `PoolProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `PoolProcessor` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `PoolProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePoolProcessor
Description	Deletes a `PoolProcessor`.
Parameters	`osid.id.Id`	`poolProcessorId`	the `Id` of the `PoolProcessor` to remove
Errors	NOT_FOUND		`poolProcessorId` not found
	NULL_ARGUMENT		`poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePoolProcessorAliases
Description	Tests if this user can manage `Id` aliases for `PoolProcessors` 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 `PoolProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPoolProcessor
Description	Adds an `Id` to a `PoolProcessor` for the purpose of creating compatibility. The primary `Id` of the `PoolProcessor` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another pool processor, it is reassigned to the given pool processor `Id`.
Parameters	`osid.id.Id`	`poolProcessorId`	the `Id` of a `PoolProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`poolProcessorId` not found
	NULL_ARGUMENT		`poolProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.