public interface MeterSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
MeterQueryInspector |
getMeterQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
MeterList |
getMeters()
Gets the meter list resulting from a search.
|
MeterSearchResultsRecord |
getMeterSearchResultsRecord(Type meterSearchRecordType)
Gets the meter search results record corresponding to the given meter
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
MeterList getMeters()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. MeterQueryInspector getMeterQueryInspector()
mandatory
- This method must be implemented. MeterSearchResultsRecord getMeterSearchResultsRecord(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.