public interface MeterSearch extends OsidSearch
The search interface for governing meter searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongMeters(IdList meterIds)
meterIds
- list of meter Ids
NullArgumentException
- meterIds
is
null
mandatory
- This method must be implemented. void orderMeterResults(MeterSearchOrder meterSearchOrder)
meterSearchOrder
- meter search orderNullArgumentException
- meterSearchOrder
is null
UnsupportedException
- meterSearchOrder
is not of this servicemandatory
- This method must be implemented. MeterSearchRecord getMeterSearchRecord(Type meterSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.meterSearchRecordType
- a meter search record typeNullArgumentException
- meterSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordTypeType(meterSearchRecordType)
is
false
mandatory
- This method must be implemented.