Interface QueueBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, QueueAdminSession
public interface QueueBatchAdminSession extends QueueAdminSession

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 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 FrontOffice , the QueueFrontOfficeAssignmentSession should be used. These delete operations attempt to remove the Queue itself thus removing it from all known FrontOffice catalogs. Bulk delete operations return the results in DeleteResponses .