org.osid.room

Interface RoomSearchOrder

All Superinterfaces:

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

public interface RoomSearchOrder
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 search order.
RoomSearchOrder	getEnclosingRoomSearchOrder() Gets the room search order.
FloorSearchOrder	getFloorSearchOrder() Gets the floor search order.
RoomSearchOrderRecord	getRoomSearchOrderRecord(Type roomRecordType) Gets the room search order record corresponding to the given room record Type.
void	orderByArea(SearchOrderStyle style) Specifies a preference for ordering the result set by the room area.
void	orderByBuilding(SearchOrderStyle style) Specifies a preference for ordering the result set by the building.
void	orderByCode(SearchOrderStyle style) Specifies a preference for ordering the result set by the room code.
void	orderByEnclosingRoom(SearchOrderStyle style) Specifies a preference for ordering the result set by the enclosing room.
void	orderByFloor(SearchOrderStyle style) Specifies a preference for ordering the result set by the floor.
void	orderByOccupancyLimit(SearchOrderStyle style) Specifies a preference for ordering the result set by the room occupancy limit.
void	orderByRoomNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by the room number.
boolean	supportsBuildingSearchOrder() Tests if a building search order is available.
boolean	supportsEnclosingRoomSearchOrder() Tests if a room search order is available.
boolean	supportsFloorSearchOrder() Tests if a floor 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 search order is available.

Returns:

true if a building search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBuildingSearchOrder

BuildingSearchOrder getBuildingSearchOrder()

Gets the building search order.

Returns:

the building search order

Throws:

UnimplementedException - supportsBuildingSearchOrder() is false

Compliance:

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

orderByFloor

void orderByFloor(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsFloorSearchOrder

boolean supportsFloorSearchOrder()

Tests if a floor order is available.

Returns:

true if a floor search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFloorSearchOrder

FloorSearchOrder getFloorSearchOrder()

Gets the floor search order.

Returns:

the floor search order

Throws:

UnimplementedException - supportsFloorSearchOrder() is false

Compliance:

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

orderByEnclosingRoom

void orderByEnclosingRoom(SearchOrderStyle style)

Specifies a preference for ordering the result set by the enclosing room.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsEnclosingRoomSearchOrder

boolean supportsEnclosingRoomSearchOrder()

Tests if a room search order is available.

Returns:

true if a room order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnclosingRoomSearchOrder

RoomSearchOrder getEnclosingRoomSearchOrder()

Gets the room search order.

Returns:

the enclosing room search order

Throws:

UnimplementedException - supportsEnclosingRoomSearchOrder() is false

Compliance:

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

orderByRoomNumber

void orderByRoomNumber(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCode

void orderByCode(SearchOrderStyle style)

Specifies a preference for ordering the result set by the room code.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByArea

void orderByArea(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByOccupancyLimit

void orderByOccupancyLimit(SearchOrderStyle style)

Specifies a preference for ordering the result set by the room occupancy limit.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getRoomSearchOrderRecord

RoomSearchOrderRecord getRoomSearchOrderRecord(Type roomRecordType)
                                               throws OperationFailedException

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

Parameters:

roomRecordType - a room record type

Returns:

the room search order record

Throws:

NullArgumentException - roomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(roomRecordType) is false

Compliance:

mandatory - This method must be implemented.