org.osid.room

Interface FloorSearchOrder

All Superinterfaces:

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

public interface FloorSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BuildingSearchOrder	getBuildingSearchOrder() Gets the building order.
FloorSearchOrderRecord	getFloorSearchOrderRecord(Type floorRecordType) Gets the floor search order record corresponding to the given floor record Type.
void	orderByBuilding(SearchOrderStyle style) Specifies a preference for ordering the result set by the building.
void	orderByGrossArea(SearchOrderStyle style) Specifies a preference for ordering the result set by the gross area.
void	orderByNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by the building number.
boolean	supportsBuildingSearchOrder() Tests if a building order is available.

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

orderByBuilding

void orderByBuilding(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBuildingSearchOrder

boolean supportsBuildingSearchOrder()

Tests if a building order is available.

Returns:

true if a building order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBuildingSearchOrder

BuildingSearchOrder getBuildingSearchOrder()

Gets the building order.

Returns:

the building search order

Throws:

UnimplementedException - supportsBuildingSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsBuildingSearchOrder() is true.

orderByNumber

void orderByNumber(SearchOrderStyle style)

Specifies a preference for ordering the result set by the building number.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByGrossArea

void orderByGrossArea(SearchOrderStyle style)

Specifies a preference for ordering the result set by the gross area.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getFloorSearchOrderRecord

FloorSearchOrderRecord getFloorSearchOrderRecord(Type floorRecordType)
                                                 throws OperationFailedException

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

Parameters:

floorRecordType - a floor record type

Returns:

the floor search order record

Throws:

NullArgumentException - floorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(floorRecordType) is false

Compliance:

mandatory - This method must be implemented.