OSID Logo
OSID Specifications
billing payment batch package
Version 3.1.0
Interfaceosid.billing.payment.batch.BillingPaymentBatchManager
Implementsosid.OsidManager
osid.billing.payment.batch.BillingPaymentBatchProfile
Used Byosid.billing.payment.BillingPaymentManager
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.PayerBatchAdminSession a PayerBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPayerBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.payment.batch.PayerBatchAdminSession a PayerBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.PaymentBatchAdminSession a PaymentBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPaymentBatchAdmin() is false
Complianceoptional This 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.IdbusinessId the Id of the Business
Returnosid.billing.payment.batch.PaymentBatchAdminSession a PaymentBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsPaymentBatchAdmin() and supportsVisibleFederation() are true