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

Interface	osid.provisioning.rules.PoolProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session creates, updates, and deletes `PoolProcessorEnablers` . 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 `PoolProcessorEnabler` , a `PoolProcessorEnablerForm` is requested using `getPoolProcessorEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PoolProcessorEnablerForm` 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 `PoolProcessorEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PoolProcessorEnablerForm` corresponds to an attempted transaction. For updates, `PoolProcessorEnablerForms` are requested to the `PoolProcessorEnabler` `Id` that is to be updated using `getPoolProcessorEnablerFormForUpdate()` . Similarly, the `PoolProcessorEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PoolProcessorEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `PoolProcessorEnablers` . To unmap a `PoolProcessorEnabler` from the current `Distributor` , the `PoolProcessorEnablerDistributorAssignmentSession` should be used. These delete operations attempt to remove the `PoolProcessorEnabler` 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	canCreatePoolProcessorEnablers
Description	Tests if this user can create `PoolProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `PoolProcessorEnabler` 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 `PoolProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePoolProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `PoolProcessorEnabler` using the desired record types. While `ProvisioningRulesManager.getPoolProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `PoolProcessorEnabler` . Providing an empty array tests if a `PoolProcessorEnabler can be cre` ated with no records.
Parameters	`osid.type.Type[]`	`poolProcessorEnablerRecordTypes`	array of pool processor enabler record types
Return	`boolean`		`true` if `PoolProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`poolProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablerFormForCreate
Description	Gets the pool processor enabler form for creating new pool processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`poolProcessorEnablerRecordTypes`	array of pool processor enabler record types
Return	`osid.provisioning.rules.PoolProcessorEnablerForm`		the pool processor enabler form
Errors	NULL_ARGUMENT		`poolProcessorEnablerRecordTypes` 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	createPoolProcessorEnabler
Description	Creates a new `PoolProcessorEnabler` .
Parameters	`osid.provisioning.rules.PoolProcessorEnablerForm`	`poolProcessorEnablerForm`	the form for this `PoolProcessorEnabler`
Return	`osid.provisioning.rules.PoolProcessorEnabler`		the new `PoolProcessorEnabler`
Errors	ILLEGAL_STATE		`poolProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`poolProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorEnablerForm` did not originate from `getPoolProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePoolProcessorEnablers
Description	Tests if this user can update `PoolProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `PoolProcessorEnabler` 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 `PoolProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablerFormForUpdate
Description	Gets the pool processor enabler form for updating an existing pool processor enabler. A new pool processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of the `PoolProcessorEnabler`
Return	`osid.provisioning.rules.PoolProcessorEnablerForm`		the pool processor enabler form
Errors	NOT_FOUND		`poolProcessorEnablerId` is not found
	NULL_ARGUMENT		`poolProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePoolProcessorEnabler
Description	Updates an existing pool processor enabler.
Parameters	`osid.provisioning.rules.PoolProcessorEnablerForm`	`poolProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`poolProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`poolProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorEnablerForm` did not originate from `getPoolProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePoolProcessorEnablers
Description	Tests if this user can delete `PoolProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `PoolProcessorEnabler` 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 `PoolProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePoolProcessorEnabler
Description	Deletes a `PoolProcessorEnabler` .
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of the `PoolProcessorEnabler` to remove
Errors	NOT_FOUND		`poolProcessorEnablerId` not found
	NULL_ARGUMENT		`poolProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePoolProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for `PoolProcessorEnablers` 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 `PoolProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPoolProcessorEnabler
Description	Adds an `Id` to a `PoolProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `PoolProcessorEnabler` 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 enabler, it is reassigned to the given pool processor enabler `Id` .
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	the `Id` of a `PoolProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`poolProcessorEnablerId` not found
	NULL_ARGUMENT		`poolProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.