OSID - osid.provisioning.BrokerAdminSession Service Interface Definition

Interface	osid.provisioning.BrokerAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Brokers.` 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 `Broker,` a `BrokerForm` is requested using `getBrokerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BrokerForm` 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 `BrokerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BrokerForm` corresponds to an attempted transaction. For updates, `BrokerForms` are requested to the `Broker` `Id` that is to be updated using `getBrokerFormForUpdate().` Similarly, the `BrokerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BrokerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Brokers.` To unmap a `Broker` from the current `Distributor,` the `BrokerDistributorAssignmentSession` should be used. These delete operations attempt to remove the `Broker` 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	canCreateBrokers
Description	Tests if this user can create `Brokers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Broker` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Broker` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBrokerWithRecordTypes
Description	Tests if this user can create a single `Broker` using the desired record types. While `ProvisioningManager.getBrokerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Broker.` Providing an empty array tests if a `Broker` can be created with no records.
Parameters	`osid.type.Type[]`	`brokerRecordTypes`	array of broker record types
Return	`boolean`		`true` if `Broker` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`brokerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerFormForCreate
Description	Gets the broker form for creating new brokers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`brokerRecordTypes`	array of broker record types
Return	`osid.provisioning.BrokerForm`		the broker form
Errors	NULL_ARGUMENT		`brokerRecordTypes` 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	createBroker
Description	Creates a new `Broker.`
Parameters	`osid.provisioning.BrokerForm`	`brokerForm`	the form for this `Broker`
Return	`osid.provisioning.Broker`		the new `Broker`
Errors	ILLEGAL_STATE		`brokerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`brokerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerForm` did not originate from `getBrokerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBrokers
Description	Tests if this user can update `Brokers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Broker` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Broker` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerFormForUpdate
Description	Gets the broker form for updating an existing broker. A new broker form should be requested for each update transaction.
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker`
Return	`osid.provisioning.BrokerForm`		the broker form
Errors	NOT_FOUND		`brokerId` is not found
	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBroker
Description	Updates an existing broker.
Parameters	`osid.provisioning.BrokerForm`	`brokerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`brokerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`brokerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerForm` did not originate from `getBrokerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBrokers
Description	Tests if this user can delete `Brokers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Broker` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Broker` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBroker
Description	Deletes a `Broker.`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the `Broker` to remove
Errors	NOT_FOUND		`brokerId` not found
	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBrokerAliases
Description	Tests if this user can manage `Id` aliases for `Brokers.` 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 `Broker` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBroker
Description	Adds an `Id` to a `Broker` for the purpose of creating compatibility. The primary `Id` of the `Broker` 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, it is reassigned to the given broker `Id.`
Parameters	`osid.id.Id`	`brokerId`	the `Id` of a `Broker`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`brokerId` not found
	NULL_ARGUMENT		`brokerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignQueues
Description	Tests if this user can assign queues to brokers. A return of true does not guarantee successful authorization. A return of false indicates that it is known assigning a queue will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer queue operations to an unauthorized user.
Return	`boolean`		`false` if queue assignment is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addQueue
Description	Adds a queue to a broker.
Parameters	`osid.id.Id`	`brokerId`	the brokerId `Id`
Parameters	`osid.id.Id`	`queueId`	the queue `Id`
Errors	ALREADY_EXISTS		queue already part of work
	NOT_FOUND		`queueId` or `brokerId` is not found
	NULL_ARGUMENT		`queueId` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeQueue
Description	Removes a queue from a broker.
Parameters	`osid.id.Id`	`brokerId`	the broker `Id`
Parameters	`osid.id.Id`	`queueId`	the queue `Id`
Errors	NOT_FOUND		queue is not part of broker
	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.