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

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