Interface MeterSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface MeterSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getMeters

MeterList getMeters()

Gets the meter list resulting from a search.

Returns:

the meter list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getMeterQueryInspector

MeterQueryInspector getMeterQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the meter query inspector

Compliance:

mandatory - This method must be implemented.

getMeterSearchResultsRecord

MeterSearchResultsRecord getMeterSearchResultsRecord(Type meterSearchRecordType)
                                              throws OperationFailedException

Gets the meter search results 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 results record

Throws:

NullArgumentException - meterSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(meterSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.