Interface | osid.acknowledgement.AcknowledgementManager | ||
---|---|---|---|
Implements | osid.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:
The acknowledgement manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getCreditLookupSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.CreditLookupSession | a CreditLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCreditLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCreditLookup() is
true. | |
Method | getCreditLookupSessionForBilling | ||
Description |
Gets the | ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
Return | osid.acknowledgement.CreditLookupSession | a CreditLookupSession | |
Errors | NOT_FOUND | no Billing found by the given Id | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCreditLookup()
and supportsVisibleFederation() are true | |
Method | getCreditQuerySession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.CreditQuerySession | a CreditQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCreditQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCreditQuery() is
true. | |
Method | getCreditQuerySessionForBilling | ||
Description |
Gets the | ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
Return | osid.acknowledgement.CreditQuerySession | a CreditQuerySession | |
Errors | NOT_FOUND | no Billing found by the given Id | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCreditQuery() and
supportsVisibleFederation() are true | |
Method | getCreditSearchSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.CreditSearchSession | a CreditSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCreditSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCreditSearch() is
true. | |
Method | getCreditSearchSessionForBilling | ||
Description |
Gets the | ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
Return | osid.acknowledgement.CreditSearchSession | a CreditSearchSession | |
Errors | NOT_FOUND | no Billing found by the given Id | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCreditSearch()
and supportsVisibleFederation() are true | |
Method | getCreditAdminSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.CreditAdminSession | a CreditAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCreditAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCreditAdmin() is
true. | |
Method | getCreditAdminSessionForBilling | ||
Description |
Gets the | ||
Parameters | osid.id.Id | billingId | the Id of the Billing |
Return | osid.acknowledgement.CreditAdminSession | a CreditAdminSession | |
Errors | NOT_FOUND | no Billing found by the given Id | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCreditAdmin() and
supportsVisibleFederation() are true | |
Method | getCreditNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.acknowledgement.CreditReceiver | creditReceiver | the receiver |
Return | osid.acknowledgement.CreditNotificationSession | a CreditNotificationSession | |
Errors | NULL_ARGUMENT | creditReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCreditNotification()
is true. | |
Method | getCreditNotificationSessionForBilling | ||
Description |
Gets the | ||
Parameters | osid.acknowledgement.CreditReceiver | creditReceiver | the receiver |
osid.id.Id | billingId | the Id of the Billing | |
Return | osid.acknowledgement.CreditNotificationSession | a CreditNotificationSession | |
Errors | NOT_FOUND | no Billing found by the given Id | |
NULL_ARGUMENT | creditReceiver or billingId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCreditNotification()
and supportsVisibleFederation() are true | |
Method | getCreditBillingSession | ||
Description |
Gets the session for retrieving credit to billing mappings. | ||
Return | osid.acknowledgement.CreditBillingSession | a CreditBillingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCreditBilling() is false | ||
Compliance | optional | This method must be implemented if supportsCreditBilling()
is true. | |
Method | getCreditBillingAssignmentSession | ||
Description |
Gets the session for assigning credit to billing mappings. | ||
Return | osid.acknowledgement.CreditBillingAssignmentSession | a CreditBillingAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCreditBillingAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsCreditBillingAssignment()
is true. | |
Method | getCreditSmartBillingSession | ||
Description |
Gets the session associated with the credit smart billing for the given billing. | ||
Parameters | osid.id.Id | billingId | the Id of the billing |
Return | osid.acknowledgement.CreditSmartBillingSession | a CreditSmartBillingSession | |
Errors | NOT_FOUND | billingId not found | |
NULL_ARGUMENT | billingId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCreditSmartBilling() is false | ||
Compliance | optional | This method must be implemented if supportsCreditSmartBilling()
is true. | |
Method | getBillingLookupSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.BillingLookupSession | a BillingLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBillingLookup()
is true. | |
Method | getBillingQuerySession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.BillingQuerySession | a BillingQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBillingQuery() is
true. | |
Method | getBillingSearchSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.BillingSearchSession | a BillingSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBillingSearch()
is true. | |
Method | getBillingAdminSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.BillingAdminSession | a BillingAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBillingAdmin() is
true. | |
Method | getBillingNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.acknowledgement.BillingReceiver | billingReceiver | the receiver |
Return | osid.acknowledgement.BillingNotificationSession | a BillingNotificationSession | |
Errors | NULL_ARGUMENT | billingReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBillingNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBillingNotification()
is true. | |
Method | getBillingHierarchySession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.BillingHierarchySession | a BillingHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsBillingHierarchy()
is true. | |
Method | getBillingHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.acknowledgement.BillingHierarchyDesignSession | a BillingHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsBillingHierarchyDesign()
is true. | |
Method | getAcknowledgementBatchManager | ||
Description |
Gets an | ||
Return | osid.acknowledgement.batch.AcknowledgementBatchManager | an AcknowledgementBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcknowledgementBach() is false | ||
Compliance | optional | This method must be implemented if supportsAcknowledgementBatch()
is true. |