OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.UtilitySearch
Implementsosid.OsidSearch
Description

The search interface for governing utility searches.

MethodsearchAmongUtilities
Description

Execute this search among the given list of utilities.

Parametersosid.id.IdListutilityIdslist of utilities
ErrorsNULL_ARGUMENT utilityIds is null
CompliancemandatoryThis method must be implemented.
MethodorderUtilityResults
Description

Specify an ordering to the search results.

Parametersosid.metering.UtilitySearchOrderutilitySearchOrderutility search order
ErrorsNULL_ARGUMENT utilitySearchOrder is null
UNSUPPORTED utilitySearchOrder is not of this service
CompliancemandatoryThis 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.TypeutilitySearchRecordTypea utility search record type
Returnosid.metering.records.UtilitySearchRecordthe utility search record
ErrorsNULL_ARGUMENT utilitySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(utilitySearchRecordType) is false
CompliancemandatoryThis method must be implemented.