OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.UtilityQuerySession
Implementsosid.OsidSession
Implemented Byosid.metering.UtilitySearchSession
Used Byosid.metering.MeteringManager
osid.metering.MeteringProxyManager
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
Compliancemandatory This method must be implemented.
MethodgetUtilityQuery
Description

Gets a utility query.

Returnosid.metering.UtilityQuery the utility query
Compliancemandatory This method must be implemented.
MethodgetUtilitiesByQuery
Description

Gets a list of Utilities matching the given utility query.

Parametersosid.metering.UtilityQueryutilityQuery the utility query
Returnosid.metering.UtilityList the returned UtilityList
ErrorsNULL_ARGUMENT utilityQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED utilityQuery is not of this service
Compliancemandatory This method must be implemented.