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 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. |
changeBranch, initialize, rollbackService
close
supportsBillingBatchAdmin, supportsCreditBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CreditBatchAdminSession getCreditBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk credit
administration service.proxy
- a proxy CreditBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCreditBatchAdmin()
is false
optional
- This method must be implemented if
supportsCreditBatchAdmin()
is true.
CreditBatchAdminSession getCreditBatchAdminSessionForBilling(Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk credit
administration service for the given billing.billingId
- the Id
of the Billing
proxy
- a proxy CreditBatchAdminSession
NotFoundException
- no Billing
found by
the given Id
NullArgumentException
- billingId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCreditBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCreditBatchAdmin()
and
supportsVisibleFederation()
are true
BillingBatchAdminSession getBillingBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk billing
administration service.proxy
- a proxy BillingBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBillingBatchAdmin()
is false
optional
- This method must be implemented if
supportsBillingBatchAdmin()
is true.