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

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