OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.UtilityQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Utility objects. The search query is constructed using the UtilityQuery. The utility record Type also specifies the record for the utility query.

Utilities may have a query record indicated by their respective record types. The query record is accessed via the UtilityQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchUtilities
Description

Tests if this user can perform Utility 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.
MethodgetUtilityQuery
Description

Gets a utility query.

Returnosid.metering.UtilityQuerythe utility query
CompliancemandatoryThis method must be implemented.
MethodgetUtilitiesByQuery
Description

Gets a list of Utilities matching the given utility query.

Parametersosid.metering.UtilityQueryutilityQuerythe utility query
Returnosid.metering.UtilityListthe returned UtilityList
ErrorsNULL_ARGUMENT utilityQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED utilityQuery is not of this service
CompliancemandatoryThis method must be implemented.