OSID Logo
OSID Specifications
acknowledgement batch package
Version 3.1.0
Interfaceosid.acknowledgement.batch.AcknowledgementBatchManager
Implementsosid.OsidManager
osid.acknowledgement.batch.AcknowledgementBatchProfile
Used Byosid.acknowledgement.AcknowledgementManager
Description

The acknowledgement batch manager provides access to acknowledgement batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • CreditBatchSession: a session to create, modify and delete credits in bulk
  • BillingBatchAdminSession: a session to create, modify and delete billings in bulk
MethodgetCreditBatchAdminSession
Description

Gets the OsidSession associated with the bulk credit administration service.

Returnosid.acknowledgement.batch.CreditBatchAdminSession a CreditBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCreditBatchAdmin() is false
Complianceoptional This method must be implemented if supportsCreditBatchAdmin() is true.
MethodgetCreditBatchAdminSessionForBilling
Description

Gets the OsidSession associated with the bulk credit administration service for the given billing.

Parametersosid.id.IdbillingId the Id of the Billing
Returnosid.acknowledgement.batch.CreditBatchAdminSession a CreditBatchAdminSession
ErrorsNOT_FOUND no Billing found by the given Id
NULL_ARGUMENT billingId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCreditBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCreditBatchAdmin() and supportsVisibleFederation() are true
MethodgetBillingBatchAdminSession
Description

Gets the OsidSession associated with the bulk billing administration service.

Returnosid.acknowledgement.batch.BillingBatchAdminSession a BillingBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBillingBatchAdmin() is false
Complianceoptional This method must be implemented if supportsBillingBatchAdmin() is true.