| Interface | osid.acknowledgement.BillingSearchSession | ||
|---|---|---|---|
| Implements | osid.acknowledgement.BillingQuerySession | ||
| Used By | osid.acknowledgement.AcknowledgementManager | ||
osid.acknowledgement.AcknowledgementProxyManager | |||
| Description |
This session provides methods for searching
getBillingsByQuery() is the basic search method
and returns a list of Billing elements. A more
advanced search may be performed with
getBillingsBySearch().It accepts a
BillingSearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getBillingsBySearch()
returns a BillingSearchResults that can be used
to access the resulting BillingList or be used to
perform a search within the result set through
BillingSearch.
Billings may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getBillingSearch | ||
| Description |
Gets a billing search. | ||
| Return | osid.acknowledgement.BillingSearch | the billing search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBillingSearchOrder | ||
| Description |
Gets a billing search order. The
| ||
| Return | osid.acknowledgement.BillingSearchOrder | the billing search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBillingsBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.acknowledgement.BillingQuery | billingQuery | the billing query |
osid.acknowledgement.BillingSearch | billingSearch | the billing search | |
| Return | osid.acknowledgement.BillingSearchResults | the search results | |
| Errors | NULL_ARGUMENT | billingQuery or billingSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | billingQuery or billingSearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBillingQueryFromInspector | ||
| Description |
Gets a billing query from an inspector. The inspector
is available from a | ||
| Parameters | osid.acknowledgement.BillingQueryInspector | billingQueryInspector | a billing query inspector |
| Return | osid.acknowledgement.BillingQuery | the billing query | |
| Errors | NULL_ARGUMENT | billingQueryInspector is null | |
| UNSUPPORTED | ibillingQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |