org.osid.room.construction

Interface RenovationSearchOrder

All Superinterfaces:

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

public interface RenovationSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RenovationSearchOrderRecord	getRenovationSearchOrderRecord(Type renovationRecordType) Gets the renovation search order record corresponding to the given renovation record Type.
void	orderByCost(SearchOrderStyle style) Specifies a preference for ordering the result set by the cost.

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.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByCost

void orderByCost(SearchOrderStyle style)

Specifies a preference for ordering the result set by the cost.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getRenovationSearchOrderRecord

RenovationSearchOrderRecord getRenovationSearchOrderRecord(Type renovationRecordType)
                                                           throws OperationFailedException

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

Parameters:

renovationRecordType - a renovation record type

Returns:

the renovation search order record

Throws:

NullArgumentException - renovationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(renovationRecordType) is false

Compliance:

mandatory - This method must be implemented.