Interface | osid.provisioning.batch.QueueBatchAdminSession | ||
---|---|---|---|
Implements | osid.provisioning.QueueAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getQueueFormsForCreate | ||
Description |
Gets the queue forms for creating a bunch of new queues. A form is returned for each supplied broker. | ||
Parameters | osid.id.IdList | brokerIds | a list of broker Ids |
osid.type.Type[] | queueRecordTypes | array of queue record types to be included in each create operation or an empty list if none | |
Return | osid.provisioning.batch.QueueBatchFormList | the queue forms | |
Errors | NOT_FOUND | a brokerId is not found | |
NULL_ARGUMENT | peers or queueRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createQueues | ||
Description |
Creates a new set of | ||
Parameters | osid.provisioning.batch.QueueBatchFormList | queueForms | the queue forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | queueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueFormsForUpdate | ||
Description |
Gets the queue forms for updating an existing set of queues. A new queue form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | queueIds | the Ids of the Queue |
Return | osid.provisioning.batch.QueueBatchFormList | the queue form | |
Errors | NOT_FOUND | a queueId is not found | |
NULL_ARGUMENT | queueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQueues | ||
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 | ||
Parameters | osid.provisioning.batch.QueueBatchFormList | queueForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | queueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllQueues | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteQueues | ||
Description |
Deletes queues for the given | ||
Parameters | osid.id.IdList | queueIds | the Ids of the queues to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | queueIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteQueuesForBroker | ||
Description |
Deletes queues for the given broker. | ||
Parameters | osid.id.Id | broekrId | the Id of a broker |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasQueues | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |