OSID Logo
OSID Specifications
billing payment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.batch.BillingPaymentBatchManager
Implementsosid.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:

  • PayerBatchAdminSession: a session to create, modify and delete Payers in bulk
  • BusinessBatchAdminSession: a session to create, modify and delete Business in bulk
MethodgetPayerBatchAdminSession
Description

Gets the OsidSession associated with the bulk payer administration service.

Returnosid.billing.payment.batch.PayerBatchAdminSessiona PayerBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPayerBatchAdmin() is true.
MethodgetPayerBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk payer administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.payment.batch.PayerBatchAdminSessiona PayerBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerBatchAdmin() and supportsVisibleFederation() are true
MethodgetPaymentBatchAdminSession
Description

Gets the OsidSession associated with the bulk payment administration service.

Returnosid.billing.payment.batch.PaymentBatchAdminSessiona PaymentBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPaymentBatchAdmin() is true.
MethodgetPaymentBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk payment administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.billing.payment.batch.PaymentBatchAdminSessiona PaymentBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentBatchAdmin() and supportsVisibleFederation() are true