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

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