OSID - osid.provisioning.QueueAdminSession Service Interface Definition

Interface	osid.provisioning.QueueAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Queues.` 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 `Queue,` a `QueueForm` is requested using `getQueueFormForCreate()` specifying the desired broker and record `Types` or none if no record `Types` are needed. The returned `QueueForm` 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 `QueueForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `QueueForm` corresponds to an attempted transaction. For updates, `QueueForms` are requested to the `Queue` `Id` that is to be updated using `getQueueFormForUpdate().` Similarly, the `QueueForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `QueueForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Queues.` To unmap a `Queue` from the current `Distributor,` the `QueueDistributorAssignmentSession` should be used. These delete operations attempt to remove the `Queue` 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	canCreateQueue
Description	Tests if this user can create queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Queue` 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 `Queue` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateQueueWithRecordTypes
Description	Tests if this user can create a single `Queue` using the desired record types. While `ProvisioningManager.getQueueRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Queue.` Providing an empty array tests if a `Queue` can be created with no records.
Parameters	`osid.type.Type[]`	`queueRecordTypes`	array of queue record types
Return	`boolean`		`true` if `Queue` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`queueRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueFormForCreate
Description	Gets the queue form for creating new queues. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
Parameters	`osid.type.Type[]`	`queueRecordTypes`	array of queue record types
Return	`osid.provisioning.QueueForm`		the queue form
Errors	NOT_FOUND		`brokerId` is not found
	NULL_ARGUMENT		`brokerId` or `queueRecordTypes` 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	createQueue
Description	Creates a new `Queue.`
Parameters	`osid.provisioning.QueueForm`	`queueForm`	the form for this `Queue`
Return	`osid.provisioning.Queue`		the new `Queue`
Errors	ILLEGAL_STATE		`queueForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`queueForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueForm` did not originate from `getQueueFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateQueues
Description	Tests if this user can update queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Queue` 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 `Queue` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQueueFormForUpdate
Description	Gets the queue form for updating an existing queue. A new queue form should be requested for each update transaction.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Return	`osid.provisioning.QueueForm`		the queue form
Errors	NOT_FOUND		`queueId` is not found
	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateQueue
Description	Updates an existing queue.
Parameters	`osid.provisioning.QueueForm`	`queueForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`queueForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`queueForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueForm` did not originate from `getQueueFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteQueues
Description	Tests if this user can delete queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Queue` 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 `Queue` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteQueue
Description	Deletes a `Queue.`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue` to remove
Errors	NOT_FOUND		`queueId` not found
	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageQueueAliases
Description	Tests if this user can manage `Id` aliases for queues. 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 `Queue` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasQueue
Description	Adds an `Id` to a `Queue` for the purpose of creating compatibility. The primary `Id` of the `Queue` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another queue, it is reassigned to the given queue `Id.`
Parameters	`osid.id.Id`	`queueId`	the `Id` of a `Queue`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`queueId` not found
	NULL_ARGUMENT		`queueId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.