OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
room package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.FloorSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getFloors | ||
| Description |
Gets the floor list resulting from a search. | ||
| Return | osid.room.FloorList | the floor list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFloorQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.room.FloorQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFloorSearchResultsRecord | ||
| Description |
Gets the floor search results record corresponding to the given floor search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | floorSearchRecordType | a floor search record type |
| Return | osid.room.records.FloorSearchResultsRecord | the floor search results record | |
| Errors | NULL_ARGUMENT | FloorSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(floorSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |