org.osid.acknowledgement

Interface AcknowledgementManager

All Superinterfaces:

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

public interface AcknowledgementManager
extends OsidManager, AcknowledgementProfile

The acknowledgement manager provides access to acknowledgement sessions and provides interoperability tests for various aspects of this service. 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
AcknowledgementBatchManager	getAcknowledgementBatchManager() Gets an AcknowledgementBatchManager.
BillingAdminSession	getBillingAdminSession() Gets the OsidSession associated with the billing administrative service.
BillingHierarchyDesignSession	getBillingHierarchyDesignSession() Gets the OsidSession associated with the billing hierarchy design service.
BillingHierarchySession	getBillingHierarchySession() Gets the OsidSession associated with the billing hierarchy service.
BillingLookupSession	getBillingLookupSession() Gets the OsidSession associated with the billing lookup service.
BillingNotificationSession	getBillingNotificationSession(BillingReceiver billingReceiver) Gets the OsidSession associated with the billing notification service.
BillingQuerySession	getBillingQuerySession() Gets the OsidSession associated with the billing query service.
BillingSearchSession	getBillingSearchSession() Gets the OsidSession associated with the billing search service.
CreditAdminSession	getCreditAdminSession() Gets the OsidSession associated with the credit administration service.
CreditAdminSession	getCreditAdminSessionForBilling(Id billingId) Gets the OsidSession associated with the credit administration service for the given billing.
CreditBillingAssignmentSession	getCreditBillingAssignmentSession() Gets the session for assigning credit to billing mappings.
CreditBillingSession	getCreditBillingSession() Gets the session for retrieving credit to billing mappings.
CreditLookupSession	getCreditLookupSession() Gets the OsidSession associated with the credit lookup service.
CreditLookupSession	getCreditLookupSessionForBilling(Id billingId) Gets the OsidSession associated with the credit lookup service for the given billing.
CreditNotificationSession	getCreditNotificationSession(CreditReceiver creditReceiver) Gets the OsidSession associated with the credit notification service.
CreditNotificationSession	getCreditNotificationSessionForBilling(CreditReceiver creditReceiver, Id billingId) Gets the OsidSession associated with the credit notification service for the given billing.
CreditQuerySession	getCreditQuerySession() Gets the OsidSession associated with the credit query service.
CreditQuerySession	getCreditQuerySessionForBilling(Id billingId) Gets the OsidSession associated with the credit query service for the given billing.
CreditSearchSession	getCreditSearchSession() Gets the OsidSession associated with the credit search service.
CreditSearchSession	getCreditSearchSessionForBilling(Id billingId) Gets the OsidSession associated with the credit search service for the given billing.
CreditSmartBillingSession	getCreditSmartBillingSession(Id billingId) Gets the session associated with the credit smart billing for the given billing.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                           throws OperationFailedException

Gets the OsidSession associated with the credit lookup service.

Returns:

a CreditLookupSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

billingId - the Id of the Billing

Returns:

a CreditLookupSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the credit query service.

Returns:

a CreditQuerySession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

billingId - the Id of the Billing

Returns:

a CreditQuerySession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the credit search service.

Returns:

a CreditSearchSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

billingId - the Id of the Billing

Returns:

a CreditSearchSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the credit administration service.

Returns:

a CreditAdminSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

billingId - the Id of the Billing

Returns:

a CreditAdminSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId 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)
                                                       throws OperationFailedException

Gets the OsidSession associated with the credit notification service.

Parameters:

creditReceiver - the receiver

Returns:

a CreditNotificationSession

Throws:

NullArgumentException - creditReceiver 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)
                                                                 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

Returns:

a CreditNotificationSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - creditReceiver or billingId 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()
                                             throws OperationFailedException

Gets the session for retrieving credit to billing mappings.

Returns:

a CreditBillingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBilling() is false

Compliance:

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

getCreditBillingAssignmentSession

CreditBillingAssignmentSession getCreditBillingAssignmentSession()
                                                                 throws OperationFailedException

Gets the session for assigning credit to billing mappings.

Returns:

a CreditBillingAssignmentSession

Throws:

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)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session associated with the credit smart billing for the given billing.

Parameters:

billingId - the Id of the billing

Returns:

a CreditSmartBillingSession

Throws:

NotFoundException - billingId not found

NullArgumentException - billingId 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the billing lookup service.

Returns:

a BillingLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingLookup() is false

Compliance:

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

getBillingQuerySession

BillingQuerySession getBillingQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the billing query service.

Returns:

a BillingQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingQuery() is false

Compliance:

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

getBillingSearchSession

BillingSearchSession getBillingSearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the billing search service.

Returns:

a BillingSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingSearch() is false

Compliance:

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

getBillingAdminSession

BillingAdminSession getBillingAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the billing administrative service.

Returns:

a BillingAdminSession

Throws:

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)
                                                         throws OperationFailedException

Gets the OsidSession associated with the billing notification service.

Parameters:

billingReceiver - the receiver

Returns:

a BillingNotificationSession

Throws:

NullArgumentException - billingReceiver 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()
                                                   throws OperationFailedException

Gets the OsidSession associated with the billing hierarchy service.

Returns:

a BillingHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingHierarchy() is false

Compliance:

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

getBillingHierarchyDesignSession

BillingHierarchyDesignSession getBillingHierarchyDesignSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the billing hierarchy design service.

Returns:

a BillingHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingHierarchyDesign() is false

Compliance:

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

getAcknowledgementBatchManager

AcknowledgementBatchManager getAcknowledgementBatchManager()
                                                           throws OperationFailedException

Gets an AcknowledgementBatchManager.

Returns:

an AcknowledgementBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAcknowledgementBach() is false

Compliance:

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