Interface | osid.room.FloorSearchSession | ||
---|---|---|---|
Implements | osid.room.FloorQuerySession | ||
Description |
This session provides methods for searching Floors may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getFloorSearch | ||
Description |
Gets a floor search. | ||
Return | osid.room.FloorSearch | the floor search | |
Compliance | mandatory | This method must be implemented. | |
Method | getFloorSearchOrder | ||
Description |
Gets a floor search order. The | ||
Return | osid.room.FloorSearchOrder | the floor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getFloorsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.room.FloorQuery | floorQuery | the floor query |
osid.room.FloorSearch | floorSearch | the floor search | |
Return | osid.room.FloorSearchResults | the floor search results | |
Errors | NULL_ARGUMENT | floorQuery or floorSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | floorQuery or floorSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFloorQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.room.FloorQueryInspector | floorQueryInspector | a query inspector |
Return | osid.room.FloorQuery | the entry query | |
Errors | NULL_ARGUMENT | floorQueryInspector is null | |
UNSUPPORTED | floorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |