OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.UtilitySearch
Implementsosid.OsidSearch
Used Byosid.metering.UtilitySearchSession
Description

The search interface for governing utility searches.

MethodsearchAmongUtilities
Description

Execute this search among the given list of utilities.

Parametersosid.id.IdListutilityIds list of utilities
ErrorsNULL_ARGUMENT utilityIds is null
Compliancemandatory This method must be implemented.
MethodorderUtilityResults
Description

Specify an ordering to the search results.

Parametersosid.metering.UtilitySearchOrderutilitySearchOrder utility search order
ErrorsNULL_ARGUMENT utilitySearchOrder is null
UNSUPPORTED utilitySearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetUtilitySearchRecord
Description

Gets the utility search record corresponding to the given utility search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeutilitySearchRecordType a utility search record type
Returnosid.metering.records.UtilitySearchRecord the utility search record
ErrorsNULL_ARGUMENT utilitySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(utilitySearchRecordType) is false
Compliancemandatory This method must be implemented.