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

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