OSID - osid.provisioning.PoolAdminSession Service Interface Definition

Interface	osid.provisioning.PoolAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Pools.` 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 `Pool,` a `PoolForm` is requested using `getPoolFormForCreate()` specifying the desired broker and record `Types` or none if no record `Types` are needed. The returned `PoolForm` 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 `PoolForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PoolForm` corresponds to an attempted transaction. For updates, `PoolForms` are requested to the `Pool` `Id` that is to be updated using `getPoolFormForUpdate().` Similarly, the `PoolForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PoolForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Pools.` To unmap a `Pool` from the current `Distributor,` the `PoolDistributorAssignmentSession` should be used. These delete operations attempt to remove the `Pool` 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	canCreatePools
Description	Tests if this user can create `Pools.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Pool` 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 `Pool` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePoolWithRecordTypes
Description	Tests if this user can create a single `Pool` using the desired record types. While `ProvisioningManager.getPoolRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Pool.` Providing an empty array tests if a `Pool` can be created with no records.
Parameters	`osid.type.Type[]`	`poolRecordTypes`	array of pool record types
Return	`boolean`		`true` if `Pool` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`poolRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolFormForCreate
Description	Gets the pool form for creating new pools. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
Parameters	`osid.type.Type[]`	`poolRecordTypes`	array of pool record types
Return	`osid.provisioning.PoolForm`		the pool form
Errors	NOT_FOUND		`brokerId` is not found
	NULL_ARGUMENT		`brokerId` or `poolRecordTypes` 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	createPool
Description	Creates a new `Pool.`
Parameters	`osid.provisioning.PoolForm`	`poolForm`	the form for this `Pool`
Return	`osid.provisioning.Pool`		the new `Pool`
Errors	ILLEGAL_STATE		`poolForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`poolForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolForm` did not originate from `getPoolFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePools
Description	Tests if this user can update `Pools.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Pool` 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 `Pool` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPoolFormForUpdate
Description	Gets the pool form for updating an existing pool. A new pool form should be requested for each update transaction.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool`
Return	`osid.provisioning.PoolForm`		the pool form
Errors	NOT_FOUND		`poolId` is not found
	NULL_ARGUMENT		`poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePool
Description	Updates an existing pool.
Parameters	`osid.provisioning.PoolForm`	`poolForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`poolForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`poolForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolForm` did not originate from `getPoolFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePools
Description	Tests if this user can delete `Pools.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Pool` 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 `Pool` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePool
Description	Deletes a `Pool.`
Parameters	`osid.id.Id`	`poolId`	the `Id` of the `Pool` to remove
Errors	NOT_FOUND		`poolId` not found
	NULL_ARGUMENT		`poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePoolAliases
Description	Tests if this user can manage `Id` aliases for `Pools.` 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 `Pool` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPool
Description	Adds an `Id` to a `Pool` for the purpose of creating compatibility. The primary `Id` of the `Pool` 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, it is reassigned to the given pool `Id.`
Parameters	`osid.id.Id`	`poolId`	the `Id` of a `Pool`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`poolId` not found
	NULL_ARGUMENT		`poolId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.