org.osid.billing.payment.batch

Interface BillingPaymentBatchManager

All Superinterfaces:

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

public interface BillingPaymentBatchManager
extends OsidManager, BillingPaymentBatchProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk payer administration service.

Returns:

a PayerBatchAdminSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a PayerBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk payment administration service.

Returns:

a PaymentBatchAdminSession

Throws:

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)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a PaymentBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId 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