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

This session provides methods for querying Billing objects. The search query is constructed using the BillingQuery.

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.

MethodcanSearchBillings
Description

Tests if this user can perform Billing searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBillingQuery
Description

Gets a billing query.

Returnosid.acknowledgement.BillingQuerythe billing query
CompliancemandatoryThis method must be implemented.
MethodgetBillingsByQuery
Description

Gets a list of Billings matching the given search.

Parametersosid.acknowledgement.BillingQuerybillingQuerythe billing query
Returnosid.acknowledgement.BillingListthe returned BillingList
ErrorsNULL_ARGUMENT billingQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED billingQuery is not of this service
CompliancemandatoryThis method must be implemented.