OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.QueueBatchAdminSession
Implementsosid.provisioning.QueueAdminSession
Description

This session creates, updates, and deletes Queues in bulk. 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 getQueueFormsForCreate() specifying the desired broker and record Types or none if no record Types are needed. Each of the returned QueueForms 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 a 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.

The QueueForms returned from getQueueFormsForCreate() may be linked to the originating request through the peer Ids of the QueueForm. In the case where there may be duplicates, any QueueForm of the same peer Ids may be used for a create operation.

Once a batch of QueueForms are submitted for create, a CreateResponse is returned for each QueueForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createQueues(), errors specific to an individual QueueForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating QueueForm through the QueueForm Id .

For updates, QueueForms are requested to the Queue Id that is to be updated using getQueueFormsForUpdate() where the reference Id in the QueueForm may be used to link the request. 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.

Once a batch of QueueForms are submitted for update, an UpdateResponse is returned for each QueueForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateQueues(), errors specific to an individual QueueForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating QueueForm through the QueueForm Id.

The delete operations delete Queues in bulk. 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. Bulk delete operations return the results in DeleteResponses.

MethodgetQueueFormsForCreate
Description

Gets the queue forms for creating a bunch of new queues. A form is returned for each supplied broker.

Parametersosid.id.IdListbrokerIdsa list of broker Ids
osid.type.Type[]queueRecordTypesarray of queue record types to be included in each create operation or an empty list if none
Returnosid.provisioning.batch.QueueBatchFormListthe queue forms
ErrorsNOT_FOUNDa brokerId is not found
NULL_ARGUMENT peers or queueRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateQueues
Description

Creates a new set of Queues. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.provisioning.batch.QueueBatchFormListqueueFormsthe queue forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT queueForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueFormsForUpdate
Description

Gets the queue forms for updating an existing set of queues. A new queue form should be requested for each update transaction.

Parametersosid.id.IdListqueueIdsthe Ids of the Queue
Returnosid.provisioning.batch.QueueBatchFormListthe queue form
ErrorsNOT_FOUNDa queueId is not found
NULL_ARGUMENT queueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQueues
Description

Updates existing queues. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.provisioning.batch.QueueBatchFormListqueueFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT queueForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllQueues
Description

Deletes all Queues in this Distributor .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteQueues
Description

Deletes queues for the given Ids.

Parametersosid.id.IdListqueueIdsthe Ids of the queues to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT queueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteQueuesForBroker
Description

Deletes queues for the given broker.

Parametersosid.id.IdbroekrIdthe Id of a broker
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasQueues
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 is an alias to the primary Id. If the alias is a pointer to another queue, it is reassigned to the given queue Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.