org.osid.acknowledgement.batch

Interface AcknowledgementBatchProxyManager

All Superinterfaces:

AcknowledgementBatchProfile, java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface AcknowledgementBatchProxyManager
extends OsidProxyManager, AcknowledgementBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
BillingBatchAdminSession	getBillingBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk billing administration service.
CreditBatchAdminSession	getCreditBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk credit administration service.
CreditBatchAdminSession	getCreditBatchAdminSessionForBilling(Id billingId, Proxy proxy) Gets the OsidSession associated with the bulk credit administration service for the given billing.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.acknowledgement.batch.AcknowledgementBatchProfile

supportsBillingBatchAdmin, supportsCreditBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCreditBatchAdminSession

CreditBatchAdminSession getCreditBatchAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk credit administration service.

Parameters:

proxy - a proxy

Returns:

a CreditBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCreditBatchAdmin() is true.

getCreditBatchAdminSessionForBilling

CreditBatchAdminSession getCreditBatchAdminSessionForBilling(Id billingId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditBatchAdminSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditBatchAdmin() and supportsVisibleFederation() are true

getBillingBatchAdminSession

BillingBatchAdminSession getBillingBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk billing administration service.

Parameters:

proxy - a proxy

Returns:

a BillingBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBillingBatchAdmin() is true.