org.osid.acknowledgement

Interface AcknowledgementProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

AcknowledgementManager, AcknowledgementProxyManager

public interface AcknowledgementProfile
extends OsidProfile

The acknowledgement profile describes the interoperability among acknowledgement services.

Method Summary

Methods

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

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supproted, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditLookup

boolean supportsCreditLookup()

Tests for the availability of a credit lookup service.

Returns:

true if credit lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditQuery

boolean supportsCreditQuery()

Tests for the availability of a credit query service.

Returns:

true if credit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditSearch

boolean supportsCreditSearch()

Tests if searching for credits is available.

Returns:

true if credit search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditAdmin

boolean supportsCreditAdmin()

Tests if managing for credits is available.

Returns:

true if a credit adminstrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditNotification

boolean supportsCreditNotification()

Tests if credit notification is available.

Returns:

true if credit notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditBilling

boolean supportsCreditBilling()

Tests if a credit to billing lookup session is available.

Returns:

true if credit billing lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditBillingAssignment

boolean supportsCreditBillingAssignment()

Tests if a credit to billing assignment session is available.

Returns:

true if credit billing assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCreditSmartBilling

boolean supportsCreditSmartBilling()

Tests if a credit smart billing session is available.

Returns:

true if credit smart billing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingLookup

boolean supportsBillingLookup()

Tests for the availability of an billing lookup service.

Returns:

true if billing lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingQuery

boolean supportsBillingQuery()

Tests if querying billings is available.

Returns:

true if billing query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingSearch

boolean supportsBillingSearch()

Tests if searching for billings is available.

Returns:

true if billing search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingAdmin

boolean supportsBillingAdmin()

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

Returns:

true if billing administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingNotification

boolean supportsBillingNotification()

Tests for the availability of a billing notification service.

Returns:

true if billing notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsBillingHierarchy

boolean supportsBillingHierarchy()

Tests for the availability of a billing hierarchy traversal service.

Returns:

true if billing hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBillingHierarchyDesign

boolean supportsBillingHierarchyDesign()

Tests for the availability of a billing hierarchy design service.

Returns:

true if billing hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsAcknowledgementBatch

boolean supportsAcknowledgementBatch()

Tests for the availability of an acknowledgement batch service.

Returns:

true if an acknowledgement batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

getCreditRecordTypes

TypeList getCreditRecordTypes()

Gets the supported Credit record types.

Returns:

a list containing the supported credit record types

Compliance:

mandatory - This method must be implemented.

supportsCreditRecordType

boolean supportsCreditRecordType(Type creditRecordType)

Tests if the given Credit record type is supported.

Parameters:

creditRecordType - a Type indicating a Credit record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - creditRecordType is null

Compliance:

mandatory - This method must be implemented.

getCreditSearchRecordTypes

TypeList getCreditSearchRecordTypes()

Gets the supported credit search record types.

Returns:

a list containing the supported credit search record types

Compliance:

mandatory - This method must be implemented.

supportsCreditSearchRecordType

boolean supportsCreditSearchRecordType(Type creditSearchRecordType)

Tests if the given credit search record type is supported.

Parameters:

creditSearchRecordType - a Type indicating a credit record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - creditSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBillingRecordTypes

TypeList getBillingRecordTypes()

Gets the supported Billing record types.

Returns:

a list containing the supported billing record types

Compliance:

mandatory - This method must be implemented.

supportsBillingRecordType

boolean supportsBillingRecordType(Type billingRecordType)

Tests if the given Billing record type is supported.

Parameters:

billingRecordType - a Type indicating a Billing record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - billingRecordType is null

Compliance:

mandatory - This method must be implemented.

getBillingSearchRecordTypes

TypeList getBillingSearchRecordTypes()

Gets the supported billing search record types.

Returns:

a list containing the supported billing search record types

Compliance:

mandatory - This method must be implemented.

supportsBillingSearchRecordType

boolean supportsBillingSearchRecordType(Type billingSearchRecordType)

Tests if the given billing search record type is supported.

Parameters:

billingSearchRecordType - a Type indicating a billing record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - billingSearchRecordType is null

Compliance:

mandatory - This method must be implemented.