OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
room package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.FloorSearchOrder | ||
|---|---|---|---|
| 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 order is available. | ||
| Return | boolean | true if a building order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBuildingSearchOrder | ||
| Description |
Gets the building 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 | orderByNumber | ||
| Description |
Specifies a preference for ordering the result set by the building number. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByGrossArea | ||
| Description |
Specifies a preference for ordering the result set by the gross area. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFloorSearchOrderRecord | ||
| Description |
Gets the floor search order record corresponding to the given floor record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | floorRecordType | a floor record type |
| Return | osid.room.records.FloorSearchOrderRecord | the floor search order record | |
| Errors | NULL_ARGUMENT | floorRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(floorRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |