| Interface | osid.provisioning.batch.DistributorBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.provisioning.DistributorAdminSession | ||
| 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 | getDistributorFormsForCreate | ||
| Description | 
                     Gets the distributor forms for creating a bunch of new distributors.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | distributorRecordTypes | array of distributor record types to be included in each create operation or an empty list if none | |
| Return | osid.provisioning.batch.DistributorBatchFormList | the distributor forms | |
| Errors | NULL_ARGUMENT |  distributorRecordTypes  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 | createDistributors | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.provisioning.batch.DistributorBatchFormList | distributorForms | the distributor forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  distributorForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistributorFormsForUpdate | ||
| Description | 
                     Gets the distributor forms for updating an existing set of distributors. A new distributor form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | distributorIds | the  Ids  of the  Distributor   | 
| Return | osid.provisioning.batch.DistributorBatchFormList | the distributor form | |
| Errors | NOT_FOUND | a  distributorId  is not found  |                 |
| NULL_ARGUMENT |  distributorIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateDistributors | ||
| Description | 
                     Updates existing distributors. 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.DistributorBatchFormList | distributorForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  distributorForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllDistributors | ||
| 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 | deleteDistributors | ||
| Description | 
                     Deletes distributors for the given   | ||
| Parameters | osid.id.IdList | distributorIds | the  Ids  of the distributors to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  distributorIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasDistributors | ||
| 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. | |