| Interface | osid.provisioning.batch.RequestBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.provisioning.RequestAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create an   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getRequestFormsForCreate | ||
| Description | 
                     Gets the request forms for creating a bunch of new requests. A form is returned for each queue and resource pair.  | ||
| Parameters | osid.provisioning.batch.RequestPeerList | peers | the relationship peers | 
osid.type.Type[] | requestRecordTypes | array of request record types to be included in each create operation or an empty list if none | |
| Return | osid.provisioning.batch.RequestBatchFormList | the request forms | |
| Errors | NOT_FOUND | a  queueId  or  resourceId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  requestRecordTypes  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 | createRequests | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.provisioning.batch.RequestBatchFormList | requestForms | the request forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  requestForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestFormsForUpdate | ||
| Description | 
                     Gets the request forms for updating an existing set of requests. A new request form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | requestIds | the  Ids  of the  Request   | 
| Return | osid.provisioning.batch.RequestBatchFormList | the request form | |
| Errors | NOT_FOUND | an  requestId  is not found  |                 |
| NULL_ARGUMENT |  requestIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateRequests | ||
| Description | 
                     Updates existing requests. 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.RequestBatchFormList | requestForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  requestForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllRequests | ||
| 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 | deleteRequests | ||
| Description | 
                     Deletes requests for the given   | ||
| Parameters | osid.id.IdList | requestIds | the  Ids  of the requests to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  requestIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRequestsForResource | ||
| Description | 
                     Deletes requests for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | an  Id  of a resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRequestsForQueue | ||
| Description | 
                     Deletes requests for the given queue.  | ||
| Parameters | osid.id.Id | queueId | an  Id  of a queue  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  queueId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveRequestsByDate | ||
| Description | 
                     Deletes requests expired before the given date.  | ||
| Parameters | osid.calendaring.DateTime | date | a date | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  date  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasRequests | ||
| 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. | |