| Interface | osid.billing.batch.CustomerBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.billing.CustomerAdminSession | ||
| 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 | getCustomerFormsForCreate | ||
| Description | 
                     Gets the customer forms for creating a bunch of new customers. A new form is returned for each supplied resource.  | ||
| Parameters | osid.id.IdList | resourceIds | a list of resource  Ids   | 
osid.type.Type[] | customerRecordTypes | array of customer record types to be included in each create operation or an empty list if none | |
| Return | osid.billing.batch.CustomerBatchFormList | the customer forms | |
| Errors | NOT_FOUND | a resource is not found | |
| NULL_ARGUMENT |  resourceIds  or  customerRecordTypes  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 | createCustomers | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.billing.batch.CustomerBatchFormList | customerForms | the customer forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  customerForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCustomerFormsForUpdate | ||
| Description | 
                     Gets the customer forms for updating an existing set of customers. A new customer form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | customerIds | the  Ids  of the  Customer   | 
| Return | osid.billing.batch.CustomerBatchFormList | the customer form | |
| Errors | NOT_FOUND | a  customerId  is not found  |                 |
| NULL_ARGUMENT |  customerIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateCustomers | ||
| Description | 
                     Updates existing customers. This method returns an 
                    error if the entire operation fails. Otherwise, the status 
                    of an individual update operation is indicated in the 
                      | ||
| Parameters | osid.billing.batch.CustomerBatchFormList | customerForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  customerForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllCustomers | ||
| 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 | deleteCustomers | ||
| Description | 
                     Deletes customers for the given   | ||
| Parameters | osid.id.IdList | customerIds | the  Ids  of the customers to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  customerIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteCustomersForResource | ||
| Description | 
                     Deletes customers for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | the  Id  of a resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  customerIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveCustomersByDate | ||
| Description | 
                     Deletes customers 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 | aliasCustomers | ||
| 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. | |