Interface BillingPaymentBatchManager

All Superinterfaces:

AutoCloseable, BillingPaymentBatchProfile, Closeable, OsidManager, 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

Modifier and Type	Method	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 BillingPaymentBatchProfile

supportsPayerBatchAdmin, supportsPaymentBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsPayerBatchAdmin()	Tests if bulk administration of payers is available.
boolean	supportsPaymentBatchAdmin()	Tests if bulk administration of payments is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsPayerBatchAdmin()} is {@code 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 {@code supportsPayerBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentBatchAdmin()} is {@code 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 {@code supportsPaymentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}