Interface MeterSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface MeterSearch
extends OsidSearch

The search interface for governing meter searches.

Method Summary

Modifier and Type	Method	Description
MeterSearchRecord	getMeterSearchRecord(Type meterSearchRecordType)	Gets the meter search record corresponding to the given meter search record Type .
void	orderMeterResults(MeterSearchOrder meterSearchOrder)	Specify an ordering to the search results.
void	searchAmongMeters(IdList meterIds)	Execute this search among the given list of meters.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongMeters

void searchAmongMeters(IdList meterIds)

Execute this search among the given list of meters.

Parameters:

meterIds - list of meter Ids

Throws:

NullArgumentException - meterIds is null

Compliance:

mandatory - This method must be implemented.

orderMeterResults

void orderMeterResults(MeterSearchOrder meterSearchOrder)

Specify an ordering to the search results.

Parameters:

meterSearchOrder - meter search order

Throws:

NullArgumentException - meterSearchOrder is null

UnsupportedException - meterSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getMeterSearchRecord

MeterSearchRecord getMeterSearchRecord(Type meterSearchRecordType)
                                throws OperationFailedException

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

Parameters:

meterSearchRecordType - a meter search record type

Returns:

the meter search record

Throws:

NullArgumentException - meterSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(meterSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.