OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.AcknowledgementProfile
Implementsosid.OsidProfile
Description

The acknowledgement profile describes the interoperability among acknowledgement services.

MethodsupportsVisibleFederation
Description

Tests if any billing federation is exposed. Federation is exposed when a specific billing may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of billings appears as a single billing.

Returnboolean true if visible federation is supproted, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditLookup
Description

Tests for the availability of a credit lookup service.

Returnboolean true if credit lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditQuery
Description

Tests for the availability of a credit query service.

Returnboolean true if credit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditSearch
Description

Tests if searching for credits is available.

Returnboolean true if credit search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditAdmin
Description

Tests if managing for credits is available.

Returnboolean true if a credit adminstrative service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditNotification
Description

Tests if credit notification is available.

Returnboolean true if credit notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditBilling
Description

Tests if a credit to billing lookup session is available.

Returnboolean true if credit billing lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditBillingAssignment
Description

Tests if a credit to billing assignment session is available.

Returnboolean true if credit billing assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditSmartBilling
Description

Tests if a credit smart billing session is available.

Returnboolean true if credit smart billing is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingLookup
Description

Tests for the availability of an billing lookup service.

Returnboolean true if billing lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingQuery
Description

Tests if querying billings is available.

Returnboolean true if billing query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingSearch
Description

Tests if searching for billings is available.

Returnboolean true if billing search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingAdmin
Description

Tests for the availability of a billing administrative service for creating and deleting billings.

Returnboolean true if billing administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingNotification
Description

Tests for the availability of a billing notification service.

Returnboolean true if billing notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsBillingHierarchy
Description

Tests for the availability of a billing hierarchy traversal service.

Returnboolean true if billing hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingHierarchyDesign
Description

Tests for the availability of a billing hierarchy design service.

Returnboolean true if billing hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsAcknowledgementBatch
Description

Tests for the availability of an acknowledgement batch service.

Returnboolean true if an acknowledgement batch service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetCreditRecordTypes
Description

Gets the supported Credit record types.

Returnosid.type.TypeLista list containing the supported credit record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditRecordType
Description

Tests if the given Credit record type is supported.

Parametersosid.type.TypecreditRecordTypea Type indicating a Credit record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT creditRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCreditSearchRecordTypes
Description

Gets the supported credit search record types.

Returnosid.type.TypeLista list containing the supported credit search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditSearchRecordType
Description

Tests if the given credit search record type is supported.

Parametersosid.type.TypecreditSearchRecordTypea Type indicating a credit record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT creditSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBillingRecordTypes
Description

Gets the supported Billing record types.

Returnosid.type.TypeLista list containing the supported billing record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingRecordType
Description

Tests if the given Billing record type is supported.

Parametersosid.type.TypebillingRecordTypea Type indicating a Billing record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT billingRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBillingSearchRecordTypes
Description

Gets the supported billing search record types.

Returnosid.type.TypeLista list containing the supported billing search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBillingSearchRecordType
Description

Tests if the given billing search record type is supported.

Parametersosid.type.TypebillingSearchRecordTypea Type indicating a billing record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT billingSearchRecordType is null
CompliancemandatoryThis method must be implemented.