org.osid.metering

Interface UtilitySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface UtilitySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
UtilitySearchOrderRecord	getUtilitySearchOrderRecord(Type utilityRecordType) Gets the utility search order record corresponding to the given utility 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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getUtilitySearchOrderRecord

UtilitySearchOrderRecord getUtilitySearchOrderRecord(Type utilityRecordType)
                                                     throws OperationFailedException

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

Parameters:

utilityRecordType - a utility record type

Returns:

the utility search order record

Throws:

NullArgumentException - utilityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(utilityRecordType) is false

Compliance:

mandatory - This method must be implemented.