OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.BillingQuerySession
Implementsosid.OsidSession
Implemented Byosid.acknowledgement.BillingSearchSession
Used Byosid.acknowledgement.AcknowledgementManager
osid.acknowledgement.AcknowledgementProxyManager
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
Compliancemandatory This method must be implemented.
MethodgetBillingQuery
Description

Gets a billing query.

Returnosid.acknowledgement.BillingQuery the billing query
Compliancemandatory This method must be implemented.
MethodgetBillingsByQuery
Description

Gets a list of Billings matching the given search.

Parametersosid.acknowledgement.BillingQuerybillingQuery the billing query
Returnosid.acknowledgement.BillingList the returned BillingList
ErrorsNULL_ARGUMENT billingQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED billingQuery is not of this service
Compliancemandatory This method must be implemented.