| Interface | osid.billing.batch.BillingBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.billing.batch.BillingBatchProfile | |||
| Description |
The billing batch manager provides access to billing batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getCustomerBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.batch.CustomerBatchAdminSession | a CustomerBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsCustomerBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerBatchAdmin()
is true. | |
| Method | getCustomerBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.batch.CustomerBatchAdminSession | a CustomerBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCustomerBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCustomerBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getItemBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.batch.ItemBatchAdminSession | an ItemBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsItemBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsItemBatchAdmin()
is true. | |
| Method | getItemBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.batch.ItemBatchAdminSession | an ItemBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsItemBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsItemBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getEntryBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.batch.EntryBatchAdminSession | an EntryBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsEntryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryBatchAdmin()
is true. | |
| Method | getEntryBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.batch.EntryBatchAdminSession | an EntryBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEntryBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsEntryBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getCategoryBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.batch.CategoryBatchAdminSession | a CategoryBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsCategoryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryBatchAdmin()
is true. | |
| Method | getCategoryBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.batch.CategoryBatchAdminSession | a CategoryBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCategoryBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCategoryBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getPeriodBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.batch.PeriodBatchAdminSession | a PeriodBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPeriodBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodBatchAdmin()
is true. | |
| Method | getPeriodBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.batch.PeriodBatchAdminSession | a PeriodBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPeriodBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPeriodBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getBusinessBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.batch.BusinessBatchAdminSession | a BusinessBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsBusinessBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsBusinessBatchAdmin()
is true. | |