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

Interface	osid.provisioning.rules.BrokerConstrainerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session creates, updates, and deletes `BrokerConstrainers` . 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 `BrokerConstrainer` , a `BrokerConstrainerForm` is requested using `getBrokerConstrainerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BrokerConstrainerForm` 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 `BrokerConstrainerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BrokerConstrainerForm` corresponds to an attempted transaction. For updates, `BrokerConstrainerForms` are requested to the `BrokerConstrainer` `Id` that is to be updated using `getBrokerConstrainerFormForUpdate()` . Similarly, the `BrokerConstrainerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BrokerConstrainerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `BrokerConstrainers` . To unmap a `BrokerConstrainer` from the current `Distributor` , the `BrokerConstrainerDistributorAssignmentSession` should be used. These delete operations attempt to remove the `BrokerConstrainer` 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	canCreateBrokerConstrainers
Description	Tests if this user can create `BrokerConstrainers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `BrokerConstrainer` 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 `BrokerConstrainer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBrokerConstrainerWithRecordTypes
Description	Tests if this user can create a single `BrokerConstrainer` using the desired record types. While `ProvisioningRulesManager.getBrokerConstrainerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `BrokerConstrainer` . Providing an empty array tests if a `BrokerConstrainer can be c` reated with no records.
Parameters	`osid.type.Type[]`	`brokerConstrainerRecordTypes`	array of broker constrainer record types
Return	`boolean`		`true` if `BrokerConstrainer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`brokerConstrainerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerFormForCreate
Description	Gets the broker constrainer form for creating new broker constrainers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`brokerConstrainerRecordTypes`	array of broker constrainer record types
Return	`osid.provisioning.rules.BrokerConstrainerForm`		the broker constrainer form
Errors	NULL_ARGUMENT		`brokerConstrainerRecordTypes` 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	createBrokerConstrainer
Description	Creates a new `BrokerConstrainer` .
Parameters	`osid.provisioning.rules.BrokerConstrainerForm`	`brokerConstrainerForm`	the form for this `BrokerConstrainer`
Return	`osid.provisioning.rules.BrokerConstrainer`		the new `BrokerConstrainer`
Errors	ILLEGAL_STATE		`brokerConstrainerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`brokerConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerConstrainerForm` did not originate from `getBrokerConstrainerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBrokerConstrainers
Description	Tests if this user can update `BrokerConstrainers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `BrokerConstrainer` 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 `BrokerConstrainer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerFormForUpdate
Description	Gets the broker constrainer form for updating an existing broker constrainer. A new broker constrainer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer`
Return	`osid.provisioning.rules.BrokerConstrainerForm`		the broker form
Errors	NOT_FOUND		`brokerConstrainerId` is not found
	NULL_ARGUMENT		`brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBrokerConstrainer
Description	Updates an existing broker constrainer.
Parameters	`osid.provisioning.rules.BrokerConstrainerForm`	`brokerConstrainerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`brokerConstrainerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`brokerConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerConstrainerForm` did not originate from `getBrokerConstrainerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBrokerConstrainers
Description	Tests if this user can delete `BrokerConstrainers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `BrokerConstrainer` 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 `BrokerConstrainer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBrokerConstrainer
Description	Deletes a `BrokerConstrainer` .
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of the `BrokerConstrainer` to remove
Errors	NOT_FOUND		`brokerConstrainerId` not found
	NULL_ARGUMENT		`brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBrokerConstrainerAliases
Description	Tests if this user can manage `Id` aliases for `BrokerConstrainers` 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 `BrokerConstrainer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBrokerConstrainer
Description	Adds an `Id` to a `BrokerConstrainer` for the purpose of creating compatibility. The primary `Id` of the `BrokerConstrainer` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another broker constrainer, it is reassigned to the given broker constrainer `Id` .
Parameters	`osid.id.Id`	`brokerConstrainerId`	the `Id` of a `BrokerConstrainer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`brokerConstrainerId` not found
	NULL_ARGUMENT		`brokerConstrainerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.