OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.BillingSearchSession
Implementsosid.acknowledgement.BillingQuerySession
Description

This session provides methods for searching Billing objects. The search query is constructed using the BillingQuery. The billing record Type also specifies the billing query record for the billing query.

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 BillingQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetBillingSearch
Description

Gets a billing search.

Returnosid.acknowledgement.BillingSearchthe billing search
CompliancemandatoryThis method must be implemented.
MethodgetBillingSearchOrder
Description

Gets a billing search order. The BillingSearchOrder is supplied to a BillingSearch to specify the ordering of results.

Returnosid.acknowledgement.BillingSearchOrderthe billing search order
CompliancemandatoryThis method must be implemented.
MethodgetBillingsBySearch
Description

Gets the search results matching the given search.

Parametersosid.acknowledgement.BillingQuerybillingQuerythe billing query
osid.acknowledgement.BillingSearchbillingSearchthe billing search
Returnosid.acknowledgement.BillingSearchResultsthe search results
ErrorsNULL_ARGUMENT billingQuery or billingSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED billingQuery or billingSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBillingQueryFromInspector
Description

Gets a billing query from an inspector. The inspector is available from a BillingSearchResults.

Parametersosid.acknowledgement.BillingQueryInspectorbillingQueryInspectora billing query inspector
Returnosid.acknowledgement.BillingQuerythe billing query
ErrorsNULL_ARGUMENT billingQueryInspector is null
UNSUPPORTED ibillingQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.