org.osid.billing.payment.batch

Interface BillingPaymentBatchProxyManager

All Superinterfaces:

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

public interface BillingPaymentBatchProxyManager
extends OsidProxyManager, BillingPaymentBatchProfile

The billing payment batch proxy manager provides access to billing payment 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:

• PayerBatchAdminSession: a session to manage payerd in bulk
• BusinessBatchAdminSession: a session to create, modify and delete Business in bulk

Method Summary

Methods

Modifier and Type	Method and Description
PayerBatchAdminSession	getPayerBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk payer administration service.
PayerBatchAdminSession	getPayerBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk payer administration service for the given business.
PaymentBatchAdminSession	getPaymentBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk payment administration service.
PaymentBatchAdminSession	getPaymentBatchAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the bulk payment administration service for the given business.

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.billing.payment.batch.BillingPaymentBatchProfile

supportsPayerBatchAdmin, supportsPaymentBatchAdmin, 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

getPayerBatchAdminSession

PayerBatchAdminSession getPayerBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk payer administration service.

Parameters:

proxy - a proxy

Returns:

a PayerBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerBatchAdmin() is false

Compliance:

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

getPayerBatchAdminSessionForBusiness

PayerBatchAdminSession getPayerBatchAdminSessionForBusiness(Id businessId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a PayerBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPaymentBatchAdminSession

PaymentBatchAdminSession getPaymentBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk payment administration service.

Parameters:

proxy - a proxy

Returns:

a PaymentBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentBatchAdmin() is false

Compliance:

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

getPaymentBatchAdminSessionForBusiness

PaymentBatchAdminSession getPaymentBatchAdminSessionForBusiness(Id businessId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a PaymentBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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