| Interface | osid.billing.batch.EntryBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.billing.EntryAdminSession | ||
| 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 | getEntryFormsForCreate | ||
| Description | 
                     Gets the entry forms for creating a bunch of new entries. A form is returned for each supplied customer, item, and period set.  | ||
| Parameters | osid.billing.batch.EntryPeerList | peers | the entry peers | 
osid.type.Type[] | entryRecordTypes | array of entry record types to be included in each create operation or an empty list if none | |
| Return | osid.billing.batch.EntryBatchFormList | the entry forms | |
| Errors | NOT_FOUND | a  customerId, itemId,  or  periodId  is not 
found  |                 |
| NULL_ARGUMENT |  peers  or  entryRecordTypes  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 | createEntries | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.billing.batch.EntryBatchFormList | entryForms | the entry forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  entryForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryFormsForUpdate | ||
| Description | 
                     Gets the entry forms for updating an existing set of entries. A new entry form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | entryIds | the  Ids  of the  Entry   | 
| Return | osid.billing.batch.EntryBatchFormList | the entry form | |
| Errors | NOT_FOUND | an  entryId  is not found  |                 |
| NULL_ARGUMENT |  entryIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateEntries | ||
| Description | 
                     Updates existing entries. 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.EntryBatchFormList | entryForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  entryForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllEntries | ||
| 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 | deleteEntries | ||
| Description | 
                     Deletes entries for the given   | ||
| Parameters | osid.id.IdList | entryIds | the  Ids  of the entries to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  entryIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteEntriesForCustomer | ||
| Description | 
                     Deletes entries for the given customer.  | ||
| Parameters | osid.id.Id | customerId | an  Id  of a customer  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  customerId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteEntriesForPeriod | ||
| Description | 
                     Deletes entries for the given period.  | ||
| Parameters | osid.id.Id | periodId | an  Id  of a period  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  periodId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveEntriesByDate | ||
| Description | 
                     Deletes entries 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 | aliasEntries | ||
| 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. | |