public interface AcknowledgementProxyManager extends OsidProxyManager, AcknowledgementProfile
The acknowledgement manager provides access to acknowledgement sessions
and provides interoperability tests for various aspects of this service.
Methods in this manager accept a Proxy
interface for
passing information from a server environment. The sessions included in
this manager are:
CreditLookupSession:
a session to lookup credits
CreditQuerySession:
a session for querying credits
CreditSearchSession:
a session to search credits
CreditAdminSession:
a session to manage credits
CreditNotificationSession:
a session to subscribe
to notifications of credit changes CreditBillingSession:
a session to look up credit
to billing mappings CreditBillingAssignmentSession:
a session to
manage credit to billing mappings CreditSmartBillingSession:
a session to manage
dynamic credit to billing mappings BillingLookupSession:
a session to retrieve
billings BillingQuerySession:
a session for querying
billings BillingSearchSession:
a session to search for
billings BillingAdminSession:
a session to create, update
and delete billings BillingNotificationSession:
a session to receive
notifications for changes in billings BillingHierarchyTraversalSession:
a session to
traverse hierarchies of billings BillingHierarchyDesignSession:
a session to manage
hierarchies of billings The acknowledgement manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
AcknowledgementBatchProxyManager |
getAcknowledgementBatchProxyManager()
Gets an
AcknowledgementBatchProxyManager. |
BillingAdminSession |
getBillingAdminSession(Proxy proxy)
Gets the
OsidSession associated with the billing
administrative service. |
BillingHierarchyDesignSession |
getBillingHierarchyDesignSession(Proxy proxy)
Gets the
OsidSession associated with the billing
hierarchy design service. |
BillingHierarchySession |
getBillingHierarchySession(Proxy proxy)
Gets the
OsidSession associated with the billing
hierarchy service. |
BillingLookupSession |
getBillingLookupSession(Proxy proxy)
Gets the
OsidSession associated with the billing lookup
service. |
BillingNotificationSession |
getBillingNotificationSession(BillingReceiver billingReceiver,
Proxy proxy)
Gets the
OsidSession associated with the billing
notification service. |
BillingQuerySession |
getBillingQuerySession(Proxy proxy)
Gets the
OsidSession associated with the billing query
service. |
BillingSearchSession |
getBillingSearchSession(Proxy proxy)
Gets the
OsidSession associated with the billing search
service. |
CreditAdminSession |
getCreditAdminSession(Proxy proxy)
Gets the
OsidSession associated with the credit
administration service. |
CreditAdminSession |
getCreditAdminSessionForBilling(Id billingId,
Proxy proxy)
Gets the
OsidSession associated with the credit
administration service for the given billing. |
CreditBillingAssignmentSession |
getCreditBillingAssignmentSession(Proxy proxy)
Gets the session for assigning credit to billing mappings.
|
CreditBillingSession |
getCreditBillingSession(Proxy proxy)
Gets the session for retrieving credit to billing mappings.
|
CreditLookupSession |
getCreditLookupSession(Proxy proxy)
Gets the
OsidSession associated with the credit lookup
service. |
CreditLookupSession |
getCreditLookupSessionForBilling(Id billingId,
Proxy proxy)
Gets the
OsidSession associated with the credit lookup
service for the given billing. |
CreditNotificationSession |
getCreditNotificationSession(CreditReceiver creditReceiver,
Proxy proxy)
Gets the
OsidSession associated with the credit
notification service. |
CreditNotificationSession |
getCreditNotificationSessionForBilling(CreditReceiver creditReceiver,
Id billingId,
Proxy proxy)
Gets the
OsidSession associated with the credit
notification service for the given billing. |
CreditQuerySession |
getCreditQuerySession(Proxy proxy)
Gets the
OsidSession associated with the credit query
service. |
CreditQuerySession |
getCreditQuerySessionForBilling(Id billingId,
Proxy proxy)
Gets the
OsidSession associated with the credit query
service for the given billing. |
CreditSearchSession |
getCreditSearchSession(Proxy proxy)
Gets the
OsidSession associated with the credit search
service. |
CreditSearchSession |
getCreditSearchSessionForBilling(Id billingId,
Proxy proxy)
Gets the
OsidSession associated with the credit search
service for the given billing. |
CreditSmartBillingSession |
getCreditSmartBillingSession(Id billingId,
Proxy proxy)
Gets the session for managing dynamic credit billings for the given
billing.
|
changeBranch, initialize, rollbackService
close
getBillingRecordTypes, getBillingSearchRecordTypes, getCreditRecordTypes, getCreditSearchRecordTypes, supportsAcknowledgementBatch, supportsBillingAdmin, supportsBillingHierarchy, supportsBillingHierarchyDesign, supportsBillingLookup, supportsBillingNotification, supportsBillingQuery, supportsBillingRecordType, supportsBillingSearch, supportsBillingSearchRecordType, supportsCreditAdmin, supportsCreditBilling, supportsCreditBillingAssignment, supportsCreditLookup, supportsCreditNotification, supportsCreditQuery, supportsCreditRecordType, supportsCreditSearch, supportsCreditSearchRecordType, supportsCreditSmartBilling, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CreditLookupSession getCreditLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the credit lookup
service.proxy
- a proxy CreditLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditLookup()
is false
optional
- This method must be implemented if
supportsCreditLookup()
is true.
CreditLookupSession getCreditLookupSessionForBilling(Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the credit lookup
service for the given billing.billingId
- the Id
of the Billing
proxy
- a proxy CreditLookupSession
NotFoundException
- no Billing
found by
the given Id
NullArgumentException
- billingId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCreditLookup()
and
supportsVisibleFederation()
are true
CreditQuerySession getCreditQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the credit query
service.proxy
- a proxy CreditQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditQuery()
is false
optional
- This method must be implemented if
supportsCreditQuery()
is true.
CreditQuerySession getCreditQuerySessionForBilling(Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the credit query
service for the given billing.billingId
- the Id
of the Billing
proxy
- a proxy CreditQuerySession
NotFoundException
- no Billing
found by
the given Id
NullArgumentException
- billingId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCreditQuery()
and
supportsVisibleFederation()
are true
CreditSearchSession getCreditSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the credit search
service.proxy
- a proxy CreditSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditSearch()
is false
optional
- This method must be implemented if
supportsCreditSearch()
is true.
CreditSearchSession getCreditSearchSessionForBilling(Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the credit search
service for the given billing.billingId
- the Id
of the Billing
proxy
- a proxy CreditSearchSession
NotFoundException
- no Billing
found by
the given Id
NullArgumentException
- billingId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCreditSearch()
and
supportsVisibleFederation()
are true
CreditAdminSession getCreditAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the credit
administration service.proxy
- a proxy CreditAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditAdmin()
is false
optional
- This method must be implemented if
supportsCreditAdmin()
is true.
CreditAdminSession getCreditAdminSessionForBilling(Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the credit
administration service for the given billing.billingId
- the Id
of the Billing
proxy
- a proxy CreditAdminSession
NotFoundException
- no Billing
found by
the given Id
NullArgumentException
- billingId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCreditAdmin()
and
supportsVisibleFederation()
are true
CreditNotificationSession getCreditNotificationSession(CreditReceiver creditReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the credit
notification service.creditReceiver
- the receiverproxy
- a proxy CreditNotificationSession
NullArgumentException
- creditReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCreditNotification()
is false
optional
- This method must be implemented if
supportsCreditNotification()
is true.
CreditNotificationSession getCreditNotificationSessionForBilling(CreditReceiver creditReceiver, Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the credit
notification service for the given billing.creditReceiver
- the receiverbillingId
- the Id
of the Billing
proxy
- a proxy CreditNotificationSession
NotFoundException
- no Billing
found by
the given Id
NullArgumentException
- creditReceiver,
billingId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCreditNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCreditNotification()
and
supportsVisibleFederation()
are true
CreditBillingSession getCreditBillingSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CreditBillingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCreditBilling()
is false
optional
- This method must be implemented if
supportsCreditBilling()
is true.
CreditBillingAssignmentSession getCreditBillingAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CreditBillingAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCreditBillingAssignment()
is false
optional
- This method must be implemented if
supportsCreditBillingAssignment()
is true.
CreditSmartBillingSession getCreditSmartBillingSession(Id billingId, Proxy proxy) throws NotFoundException, OperationFailedException
billingId
- the Id
of a billingproxy
- a proxy CreditSmartBillingSession
NotFoundException
- billingId
is not
foundNullArgumentException
- billingId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCreditSmartBilling()
is false
optional
- This method must be implemented if
supportsCreditSmartBilling()
is true.
BillingLookupSession getBillingLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing lookup
service.proxy
- a proxy BillingLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBillingLookup()
is false
optional
- This method must be implemented if
supportsBillingLookup()
is true.
BillingQuerySession getBillingQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing query
service.proxy
- a proxy BillingQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBillingQuery()
is false
optional
- This method must be implemented if
supportsBillingQuery()
is true.
BillingSearchSession getBillingSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing search
service.proxy
- a proxy BillingSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBillingSearch()
is false
optional
- This method must be implemented if
supportsBillingSearch()
is true.
BillingAdminSession getBillingAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing
administrative service.proxy
- a proxy BillingAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBillingAdmin()
is false
optional
- This method must be implemented if
supportsBillingAdmin()
is true.
BillingNotificationSession getBillingNotificationSession(BillingReceiver billingReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing
notification service.billingReceiver
- the receiverproxy
- a proxy BillingNotificationSession
NullArgumentException
- billingReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBillingNotification()
is false
optional
- This method must be implemented if
supportsBillingNotification()
is true.
BillingHierarchySession getBillingHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing
hierarchy service.proxy
- a proxy BillingHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBillingHierarchy()
is false
optional
- This method must be implemented if
supportsBillingHierarchy()
is true.
BillingHierarchyDesignSession getBillingHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the billing
hierarchy design service.proxy
- a proxy BillingHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBillingHierarchyDesign()
is false
optional
- This method must be implemented if
supportsBillingHierarchyDesign()
is true.
AcknowledgementBatchProxyManager getAcknowledgementBatchProxyManager() throws OperationFailedException
AcknowledgementBatchProxyManager.
AcknowledgementBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAcknowledgementBach()
is false
optional
- This method must be implemented if
supportsAcknowledgementBatch()
is true.