org.osid.acknowledgement

Interface AcknowledgementProxyManager

All Superinterfaces:

AcknowledgementProfile, java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.acknowledgement.AcknowledgementProfile

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

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

getCreditLookupSession

CreditLookupSession getCreditLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the credit lookup service.

Parameters:

proxy - a proxy

Returns:

a CreditLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditLookup() is false

Compliance:

optional - This method must be implemented if supportsCreditLookup() is true.

getCreditLookupSessionForBilling

CreditLookupSession getCreditLookupSessionForBilling(Id billingId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the credit lookup service for the given billing.

Parameters:

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditLookupSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditLookup() and supportsVisibleFederation() are true

getCreditQuerySession

CreditQuerySession getCreditQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the credit query service.

Parameters:

proxy - a proxy

Returns:

a CreditQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditQuery() is false

Compliance:

optional - This method must be implemented if supportsCreditQuery() is true.

getCreditQuerySessionForBilling

CreditQuerySession getCreditQuerySessionForBilling(Id billingId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the credit query service for the given billing.

Parameters:

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditQuerySession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditQuery() and supportsVisibleFederation() are true

getCreditSearchSession

CreditSearchSession getCreditSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the credit search service.

Parameters:

proxy - a proxy

Returns:

a CreditSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditSearch() is false

Compliance:

optional - This method must be implemented if supportsCreditSearch() is true.

getCreditSearchSessionForBilling

CreditSearchSession getCreditSearchSessionForBilling(Id billingId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the credit search service for the given billing.

Parameters:

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditSearchSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditSearch() and supportsVisibleFederation() are true

getCreditAdminSession

CreditAdminSession getCreditAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the credit administration service.

Parameters:

proxy - a proxy

Returns:

a CreditAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditAdmin() is false

Compliance:

optional - This method must be implemented if supportsCreditAdmin() is true.

getCreditAdminSessionForBilling

CreditAdminSession getCreditAdminSessionForBilling(Id billingId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the credit administration service for the given billing.

Parameters:

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditAdminSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditAdmin() and supportsVisibleFederation() are true

getCreditNotificationSession

CreditNotificationSession getCreditNotificationSession(CreditReceiver creditReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the credit notification service.

Parameters:

creditReceiver - the receiver

proxy - a proxy

Returns:

a CreditNotificationSession

Throws:

NullArgumentException - creditReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditNotification() is false

Compliance:

optional - This method must be implemented if supportsCreditNotification() is true.

getCreditNotificationSessionForBilling

CreditNotificationSession getCreditNotificationSessionForBilling(CreditReceiver creditReceiver,
                                                               Id billingId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the credit notification service for the given billing.

Parameters:

creditReceiver - the receiver

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditNotificationSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - creditReceiver, billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditNotification() and supportsVisibleFederation() are true

getCreditBillingSession

CreditBillingSession getCreditBillingSession(Proxy proxy)
                                             throws OperationFailedException

Gets the session for retrieving credit to billing mappings.

Parameters:

proxy - a proxy

Returns:

a CreditBillingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBilling() is false

Compliance:

optional - This method must be implemented if supportsCreditBilling() is true.

getCreditBillingAssignmentSession

CreditBillingAssignmentSession getCreditBillingAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session for assigning credit to billing mappings.

Parameters:

proxy - a proxy

Returns:

a CreditBillingAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBillingAssignment() is false

Compliance:

optional - This method must be implemented if supportsCreditBillingAssignment() is true.

getCreditSmartBillingSession

CreditSmartBillingSession getCreditSmartBillingSession(Id billingId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic credit billings for the given billing.

Parameters:

billingId - the Id of a billing

proxy - a proxy

Returns:

a CreditSmartBillingSession

Throws:

NotFoundException - billingId is not found

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditSmartBilling() is false

Compliance:

optional - This method must be implemented if supportsCreditSmartBilling() is true.

getBillingLookupSession

BillingLookupSession getBillingLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the billing lookup service.

Parameters:

proxy - a proxy

Returns:

a BillingLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingLookup() is false

Compliance:

optional - This method must be implemented if supportsBillingLookup() is true.

getBillingQuerySession

BillingQuerySession getBillingQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the billing query service.

Parameters:

proxy - a proxy

Returns:

a BillingQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingQuery() is false

Compliance:

optional - This method must be implemented if supportsBillingQuery() is true.

getBillingSearchSession

BillingSearchSession getBillingSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the billing search service.

Parameters:

proxy - a proxy

Returns:

a BillingSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingSearch() is false

Compliance:

optional - This method must be implemented if supportsBillingSearch() is true.

getBillingAdminSession

BillingAdminSession getBillingAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the billing administrative service.

Parameters:

proxy - a proxy

Returns:

a BillingAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingAdmin() is false

Compliance:

optional - This method must be implemented if supportsBillingAdmin() is true.

getBillingNotificationSession

BillingNotificationSession getBillingNotificationSession(BillingReceiver billingReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the billing notification service.

Parameters:

billingReceiver - the receiver

proxy - a proxy

Returns:

a BillingNotificationSession

Throws:

NullArgumentException - billingReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingNotification() is false

Compliance:

optional - This method must be implemented if supportsBillingNotification() is true.

getBillingHierarchySession

BillingHierarchySession getBillingHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the billing hierarchy service.

Parameters:

proxy - a proxy

Returns:

a BillingHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingHierarchy() is false

Compliance:

optional - This method must be implemented if supportsBillingHierarchy() is true.

getBillingHierarchyDesignSession

BillingHierarchyDesignSession getBillingHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the billing hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a BillingHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsBillingHierarchyDesign() is true.

getAcknowledgementBatchProxyManager

AcknowledgementBatchProxyManager getAcknowledgementBatchProxyManager()
                                                                     throws OperationFailedException

Gets an AcknowledgementBatchProxyManager.

Returns:

an AcknowledgementBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgementBach() is false

Compliance:

optional - This method must be implemented if supportsAcknowledgementBatch() is true.