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

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