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 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. |
changeBranch, initialize, rollbackService
close
supportsPayerBatchAdmin, supportsPaymentBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PayerBatchAdminSession getPayerBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk payer
administration service.proxy
- a proxy PayerBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPayerBatchAdmin()
is false
optional
- This method must be implemented if
supportsPayerBatchAdmin()
is true.
PayerBatchAdminSession getPayerBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk payer
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy PayerBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPayerBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPayerBatchAdmin()
and
supportsVisibleFederation()
are true
PaymentBatchAdminSession getPaymentBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk payment
administration service.proxy
- a proxy PaymentBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentBatchAdmin()
is false
optional
- This method must be implemented if
supportsPaymentBatchAdmin()
is true.
PaymentBatchAdminSession getPaymentBatchAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk payment
administration service for the given business.businessId
- the Id
of the Business
proxy
- a proxy PaymentBatchAdminSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPaymentBatchAdmin()
and
supportsVisibleFederation()
are true