org.osid.metering

Interface MeterSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface MeterSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
MeterSearchOrderRecord	getMeterSearchOrderRecord(Type meterRecordType) Gets the meter search order record corresponding to the given meter record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

getMeterSearchOrderRecord

MeterSearchOrderRecord getMeterSearchOrderRecord(Type meterRecordType)
                                                 throws OperationFailedException

Gets the meter search order record corresponding to the given meter record Type. Multiple retrievals return the same underlying object.

Parameters:

meterRecordType - a meter record type

Returns:

the meter search order record

Throws:

NullArgumentException - meterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(meterRecordType) is false

Compliance:

mandatory - This method must be implemented.