| Interface | osid.provisioning.batch.ProvisionBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.provisioning.ProvisionAdminSession | ||
| 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 | getProvisionFormsForCreate | ||
| Description | 
                     Gets the provision forms for creating a bunch of new provisions. A form is returned for each supplied provisionable, request, and broker.  | ||
| Parameters | cardinal | peers | a list of provision peers | 
osid.type.Type[] | provisionRecordTypes | array of provision record types to be included in each create operation or an empty list if none | |
| Return | osid.provisioning.batch.ProvisionBatchFormList | the provision forms | |
| Errors | NOT_FOUND | a  provisionableId,   requestId,  or  
brokerId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  provisionRecordTypes  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 | createProvisions | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.provisioning.batch.ProvisionBatchFormList | provisionForms | the provision forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  provisionForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionFormsForUpdate | ||
| Description | 
                     Gets the provision forms for updating an existing set of provisions. A new provision form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | provisionIds | the  Ids  of the  Provision   | 
| Return | osid.provisioning.batch.ProvisionBatchFormList | the provision form | |
| Errors | NOT_FOUND | a  provisionId  is not found  |                 |
| NULL_ARGUMENT |  provisionIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateProvisions | ||
| Description | 
                     Updates existing provisions. 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.ProvisionBatchFormList | provisionForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  provisionForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllProvisions | ||
| 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 | deleteProvisions | ||
| Description | 
                     Deletes provisions for the given   | ||
| Parameters | osid.id.IdList | provisionIds | the  Ids  of the provisions to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  provisionIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProvisionsForBroker | ||
| Description | 
                     Deletes provisions for the given broker.  | ||
| Parameters | osid.id.Id | brokerId | 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 | deleteProvisionsForProvisionable | ||
| Description | 
                     Deletes provisions for the given provisionable.  | ||
| Parameters | osid.id.Id | provisionableId | the  Id  of a provisionable  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  provisionableId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProvisionsForRecipient | ||
| Description | 
                     Deletes provisions for the given recipient.  | ||
| Parameters | osid.id.Id | resourceId | the  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 | deleteProvisionsForRequest | ||
| Description | 
                     Deletes provisions for the given request.  | ||
| Parameters | osid.id.Id | requestId | the  Id  of a request  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  requestId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveProvisionsByDate | ||
| Description | 
                     Deletes provisions 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 | aliasProvisions | ||
| 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. | |