OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.AcknowledgementManager
Implementsosid.OsidManager
osid.acknowledgement.AcknowledgementProfile
Description

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.

MethodgetCreditLookupSession
Description

Gets the OsidSession associated with the credit lookup service.

Returnosid.acknowledgement.CreditLookupSessiona CreditLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditLookup() is false
ComplianceoptionalThis method must be implemented if supportsCreditLookup() is true.
MethodgetCreditLookupSessionForBilling
Description

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

Parametersosid.id.IdbillingIdthe Id of the Billing
Returnosid.acknowledgement.CreditLookupSessiona CreditLookupSession
ErrorsNOT_FOUNDno Billing found by the given Id
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCreditLookup() and supportsVisibleFederation() are true
MethodgetCreditQuerySession
Description

Gets the OsidSession associated with the credit query service.

Returnosid.acknowledgement.CreditQuerySessiona CreditQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditQuery() is false
ComplianceoptionalThis method must be implemented if supportsCreditQuery() is true.
MethodgetCreditQuerySessionForBilling
Description

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

Parametersosid.id.IdbillingIdthe Id of the Billing
Returnosid.acknowledgement.CreditQuerySessiona CreditQuerySession
ErrorsNOT_FOUNDno Billing found by the given Id
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCreditQuery() and supportsVisibleFederation() are true
MethodgetCreditSearchSession
Description

Gets the OsidSession associated with the credit search service.

Returnosid.acknowledgement.CreditSearchSessiona CreditSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditSearch() is false
ComplianceoptionalThis method must be implemented if supportsCreditSearch() is true.
MethodgetCreditSearchSessionForBilling
Description

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

Parametersosid.id.IdbillingIdthe Id of the Billing
Returnosid.acknowledgement.CreditSearchSessiona CreditSearchSession
ErrorsNOT_FOUNDno Billing found by the given Id
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCreditSearch() and supportsVisibleFederation() are true
MethodgetCreditAdminSession
Description

Gets the OsidSession associated with the credit administration service.

Returnosid.acknowledgement.CreditAdminSessiona CreditAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCreditAdmin() is true.
MethodgetCreditAdminSessionForBilling
Description

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

Parametersosid.id.IdbillingIdthe Id of the Billing
Returnosid.acknowledgement.CreditAdminSessiona CreditAdminSession
ErrorsNOT_FOUNDno Billing found by the given Id
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCreditAdmin() and supportsVisibleFederation() are true
MethodgetCreditNotificationSession
Description

Gets the OsidSession associated with the credit notification service.

Parametersosid.acknowledgement.CreditReceivercreditReceiverthe receiver
Returnosid.acknowledgement.CreditNotificationSessiona CreditNotificationSession
ErrorsNULL_ARGUMENT creditReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditNotification() is false
ComplianceoptionalThis method must be implemented if supportsCreditNotification() is true.
MethodgetCreditNotificationSessionForBilling
Description

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

Parametersosid.acknowledgement.CreditReceivercreditReceiverthe receiver
osid.id.IdbillingIdthe Id of the Billing
Returnosid.acknowledgement.CreditNotificationSessiona CreditNotificationSession
ErrorsNOT_FOUNDno Billing found by the given Id
NULL_ARGUMENT creditReceiver or billingId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCreditNotification() and supportsVisibleFederation() are true
MethodgetCreditBillingSession
Description

Gets the session for retrieving credit to billing mappings.

Returnosid.acknowledgement.CreditBillingSessiona CreditBillingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditBilling() is false
ComplianceoptionalThis method must be implemented if supportsCreditBilling() is true.
MethodgetCreditBillingAssignmentSession
Description

Gets the session for assigning credit to billing mappings.

Returnosid.acknowledgement.CreditBillingAssignmentSessiona CreditBillingAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditBillingAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCreditBillingAssignment() is true.
MethodgetCreditSmartBillingSession
Description

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

Parametersosid.id.IdbillingIdthe Id of the billing
Returnosid.acknowledgement.CreditSmartBillingSessiona CreditSmartBillingSession
ErrorsNOT_FOUND billingId not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCreditSmartBilling() is false
ComplianceoptionalThis method must be implemented if supportsCreditSmartBilling() is true.
MethodgetBillingLookupSession
Description

Gets the OsidSession associated with the billing lookup service.

Returnosid.acknowledgement.BillingLookupSessiona BillingLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingLookup() is false
ComplianceoptionalThis method must be implemented if supportsBillingLookup() is true.
MethodgetBillingQuerySession
Description

Gets the OsidSession associated with the billing query service.

Returnosid.acknowledgement.BillingQuerySessiona BillingQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingQuery() is false
ComplianceoptionalThis method must be implemented if supportsBillingQuery() is true.
MethodgetBillingSearchSession
Description

Gets the OsidSession associated with the billing search service.

Returnosid.acknowledgement.BillingSearchSessiona BillingSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingSearch() is false
ComplianceoptionalThis method must be implemented if supportsBillingSearch() is true.
MethodgetBillingAdminSession
Description

Gets the OsidSession associated with the billing administrative service.

Returnosid.acknowledgement.BillingAdminSessiona BillingAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBillingAdmin() is true.
MethodgetBillingNotificationSession
Description

Gets the OsidSession associated with the billing notification service.

Parametersosid.acknowledgement.BillingReceiverbillingReceiverthe receiver
Returnosid.acknowledgement.BillingNotificationSessiona BillingNotificationSession
ErrorsNULL_ARGUMENT billingReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingNotification() is false
ComplianceoptionalThis method must be implemented if supportsBillingNotification() is true.
MethodgetBillingHierarchySession
Description

Gets the OsidSession associated with the billing hierarchy service.

Returnosid.acknowledgement.BillingHierarchySessiona BillingHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsBillingHierarchy() is true.
MethodgetBillingHierarchyDesignSession
Description

Gets the OsidSession associated with the billing hierarchy design service.

Returnosid.acknowledgement.BillingHierarchyDesignSessiona BillingHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsBillingHierarchyDesign() is true.
MethodgetAcknowledgementBatchManager
Description

Gets an AcknowledgementBatchManager.

Returnosid.acknowledgement.batch.AcknowledgementBatchManageran AcknowledgementBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcknowledgementBach() is false
ComplianceoptionalThis method must be implemented if supportsAcknowledgementBatch() is true.