Interface AcknowledgementManager

All Superinterfaces:

AcknowledgementProfile, AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 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

Modifier and Type	Method	Description
TypeList	getBillingRecordTypes()	Gets the supported Billing record types.
TypeList	getBillingSearchRecordTypes()	Gets the supported billing search record types.
TypeList	getCreditRecordTypes()	Gets the supported Credit record types.
TypeList	getCreditSearchRecordTypes()	Gets the supported credit search record types.
boolean	supportsAcknowledgementBatch()	Tests for the availability of an acknowledgement batch service.
boolean	supportsBillingAdmin()	Tests for the availability of a billing administrative service for creating and deleting billings.
boolean	supportsBillingHierarchy()	Tests for the availability of a billing hierarchy traversal service.
boolean	supportsBillingHierarchyDesign()	Tests for the availability of a billing hierarchy design service.
boolean	supportsBillingLookup()	Tests for the availability of a billing lookup service.
boolean	supportsBillingNotification()	Tests for the availability of a billing notification service.
boolean	supportsBillingQuery()	Tests if querying billings is available.
boolean	supportsBillingRecordType(Type billingRecordType)	Tests if the given Billing record type is supported.
boolean	supportsBillingSearch()	Tests if searching for billings is available.
boolean	supportsBillingSearchRecordType(Type billingSearchRecordType)	Tests if the given billing search record type is supported.
boolean	supportsCreditAdmin()	Tests if managing for credits is available.
boolean	supportsCreditBilling()	Tests if a credit to billing lookup session is available.
boolean	supportsCreditBillingAssignment()	Tests if a credit to billing assignment session is available.
boolean	supportsCreditLookup()	Tests for the availability of a credit lookup service.
boolean	supportsCreditNotification()	Tests if credit notification is available.
boolean	supportsCreditQuery()	Tests for the availability of a credit query service.
boolean	supportsCreditRecordType(Type creditRecordType)	Tests if the given Credit record type is supported.
boolean	supportsCreditSearch()	Tests if searching for credits is available.
boolean	supportsCreditSearchRecordType(Type creditSearchRecordType)	Tests if the given credit search record type is supported.
boolean	supportsCreditSmartBilling()	Tests if a credit smart billing session is available.
boolean	supportsVisibleFederation()	Tests if any billing federation is exposed.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsCreditLookup()} is {@code 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 {@code supportsCreditLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCreditQuery()} is {@code 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 {@code supportsCreditQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCreditSearch()} is {@code 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 {@code supportsCreditSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCreditAdmin()} is {@code 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 {@code supportsCreditAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCreditNotification()} is {@code 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 {@code supportsCreditNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCreditBilling()} is {@code 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 {@code supportsCreditBillingAssignment()} is {@code 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 {@code supportsCreditSmartBilling()} is {@code 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 {@code supportsBillingLookup()} is {@code 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 {@code supportsBillingQuery()} is {@code 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 {@code supportsBillingSearch()} is {@code 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 {@code supportsBillingAdmin()} is {@code 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 {@code supportsBillingNotification()} is {@code 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 {@code supportsBillingHierarchy()} is {@code 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 {@code supportsBillingHierarchyDesign()} is {@code 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 {@code supportsAcknowledgementBatch()} is {@code true} .