public interface RoomSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByBuilding(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBuildingSearchOrder()
true
if a building search order is available,
false
otherwisemandatory
- This method must be implemented. BuildingSearchOrder getBuildingSearchOrder()
UnimplementedException
-
supportsBuildingSearchOrder()
is false
optional
- This method must be implemented if
supportsBuildingSearchOrder()
is true.
void orderByFloor(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsFloorSearchOrder()
true
if a floor search order is available,
false
otherwisemandatory
- This method must be implemented. FloorSearchOrder getFloorSearchOrder()
UnimplementedException
-
supportsFloorSearchOrder()
is false
optional
- This method must be implemented if
supportsFloorSearchOrder()
is true.
void orderByEnclosingRoom(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsEnclosingRoomSearchOrder()
true
if a room order is available, false
otherwisemandatory
- This method must be implemented. RoomSearchOrder getEnclosingRoomSearchOrder()
UnimplementedException
-
supportsEnclosingRoomSearchOrder()
is false
optional
- This method must be implemented if
supportsEnclosingRoomSearchOrder()
is true.
void orderByRoomNumber(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCode(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByArea(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOccupancyLimit(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. RoomSearchOrderRecord getRoomSearchOrderRecord(Type roomRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.roomRecordType
- a room record typeNullArgumentException
- roomRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(roomRecordType)
is false
mandatory
- This method must be implemented.