Interface | osid.room.RoomSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
osid.OsidSubjugateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByBuilding | ||
Description |
Specifies a preference for ordering the result set by the building. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBuildingSearchOrder | ||
Description |
Tests if a building search order is available. | ||
Return | boolean | true if a building search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingSearchOrder | ||
Description |
Gets the building search order. | ||
Return | osid.room.BuildingSearchOrder | the building search order | |
Errors | UNIMPLEMENTED | supportsBuildingSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsBuildingSearchOrder()
is true. | |
Method | orderByFloor | ||
Description |
Specifies a preference for ordering the result set by the floor. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFloorSearchOrder | ||
Description |
Tests if a floor order is available. | ||
Return | boolean | true if a floor search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFloorSearchOrder | ||
Description |
Gets the floor search order. | ||
Return | osid.room.FloorSearchOrder | the floor search order | |
Errors | UNIMPLEMENTED | supportsFloorSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsFloorSearchOrder()
is true. | |
Method | orderByEnclosingRoom | ||
Description |
Specifies a preference for ordering the result set by the enclosing room. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsEnclosingRoomSearchOrder | ||
Description |
Tests if a room search order is available. | ||
Return | boolean | true if a room order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnclosingRoomSearchOrder | ||
Description |
Gets the room search order. | ||
Return | osid.room.RoomSearchOrder | the enclosing room search order | |
Errors | UNIMPLEMENTED | supportsEnclosingRoomSearchOrder() is false | |
Compliance | optional | This method must be implemented if
supportsEnclosingRoomSearchOrder() is true. | |
Method | orderByRoomNumber | ||
Description |
Specifies a preference for ordering the result set by the room number. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCode | ||
Description |
Specifies a preference for ordering the result set by the room code. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByArea | ||
Description |
Specifies a preference for ordering the result set by the room area. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByOccupancyLimit | ||
Description |
Specifies a preference for ordering the result set by the room occupancy limit. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomSearchOrderRecord | ||
Description |
Gets the room search order record corresponding to the
given room record | ||
Parameters | osid.type.Type | roomRecordType | a room record type |
Return | osid.room.records.RoomSearchOrderRecord | the room search order record | |
Errors | NULL_ARGUMENT | roomRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(roomRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |