OSID Logo
OSID Specifications
acknowledgement batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.batch.AcknowledgementBatchProxyManager
Implementsosid.OsidProxyManager
osid.acknowledgement.batch.AcknowledgementBatchProfile
Description

The acknowledgement batch proxy manager provides access to acknowledgement batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.acknowledgement.batch.CreditBatchAdminSessiona CreditBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditBatchAdmin() is false
ComplianceoptionalThis 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.IdbillingIdthe Id of the Billing
osid.proxy.Proxyproxya proxy
Returnosid.acknowledgement.batch.CreditBatchAdminSessiona CreditBatchAdminSession
ErrorsNOT_FOUNDno Billing found by the given Id
NULL_ARGUMENT billingId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCreditBatchAdmin() and supportsVisibleFederation() are true
MethodgetBillingBatchAdminSession
Description

Gets the OsidSession associated with the bulk billing administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.acknowledgement.batch.BillingBatchAdminSessiona BillingBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBillingBatchAdmin() is true.