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

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