Interface | osid.acknowledgement.AcknowledgementProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The acknowledgement profile describes the interoperability among acknowledgement services. | ||
Method | supportsVisibleFederation | ||
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. | ||
Return | boolean | true if visible federation is supproted, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditLookup | ||
Description |
Tests for the availability of a credit lookup service. | ||
Return | boolean | true if credit lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditQuery | ||
Description |
Tests for the availability of a credit query service. | ||
Return | boolean | true if credit query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditSearch | ||
Description |
Tests if searching for credits is available. | ||
Return | boolean | true if credit search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditAdmin | ||
Description |
Tests if managing for credits is available. | ||
Return | boolean | true if a credit adminstrative service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditNotification | ||
Description |
Tests if credit notification is available. | ||
Return | boolean | true if credit notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditBilling | ||
Description |
Tests if a credit to billing lookup session is available. | ||
Return | boolean | true if credit billing lookup session is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditBillingAssignment | ||
Description |
Tests if a credit to billing assignment session is available. | ||
Return | boolean | true if credit billing assignment is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditSmartBilling | ||
Description |
Tests if a credit smart billing session is available. | ||
Return | boolean | true if credit smart billing is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingLookup | ||
Description |
Tests for the availability of an billing lookup service. | ||
Return | boolean | true if billing lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingQuery | ||
Description |
Tests if querying billings is available. | ||
Return | boolean | true if billing query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingSearch | ||
Description |
Tests if searching for billings is available. | ||
Return | boolean | true if billing search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingAdmin | ||
Description |
Tests for the availability of a billing administrative service for creating and deleting billings. | ||
Return | boolean | true if billing administration is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingNotification | ||
Description |
Tests for the availability of a billing notification service. | ||
Return | boolean | true if billing notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsBillingHierarchy | ||
Description |
Tests for the availability of a billing hierarchy traversal service. | ||
Return | boolean | true if billing hierarchy traversal is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingHierarchyDesign | ||
Description |
Tests for the availability of a billing hierarchy design service. | ||
Return | boolean | true if billing hierarchy design is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsAcknowledgementBatch | ||
Description |
Tests for the availability of an acknowledgement batch service. | ||
Return | boolean | true if an acknowledgement batch service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | getCreditRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported credit record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | creditRecordType | a Type indicating a Credit record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | creditRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditSearchRecordTypes | ||
Description |
Gets the supported credit search record types. | ||
Return | osid.type.TypeList | a list containing the supported credit search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditSearchRecordType | ||
Description |
Tests if the given credit search record type is supported. | ||
Parameters | osid.type.Type | creditSearchRecordType | a Type indicating a credit record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | creditSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBillingRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported billing record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | billingRecordType | a Type indicating a Billing record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | billingRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBillingSearchRecordTypes | ||
Description |
Gets the supported billing search record types. | ||
Return | osid.type.TypeList | a list containing the supported billing search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBillingSearchRecordType | ||
Description |
Tests if the given billing search record type is supported. | ||
Parameters | osid.type.Type | billingSearchRecordType | a Type indicating a billing record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | billingSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |