| Interface | osid.billing.payment.batch.BillingPaymentBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.billing.payment.batch.BillingPaymentBatchProfile | |||
| Description |
The billing payment batch manager provides access to billing payment batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getPayerBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.payment.batch.PayerBatchAdminSession | a PayerBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPayerBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPayerBatchAdmin()
is true. | |
| Method | getPayerBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.payment.batch.PayerBatchAdminSession | a PayerBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPayerBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPayerBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getPaymentBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.billing.payment.batch.PaymentBatchAdminSession | a PaymentBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPaymentBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPaymentBatchAdmin()
is true. | |
| Method | getPaymentBatchAdminSessionForBusiness | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
| Return | osid.billing.payment.batch.PaymentBatchAdminSession | a PaymentBatchAdminSession | |
| Errors | NOT_FOUND | no Business found by the given Id | |
| NULL_ARGUMENT | businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPaymentBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPaymentBatchAdmin()
and supportsVisibleFederation() are true | |