Interface | osid.room.RoomSearchSession | ||
---|---|---|---|
Implements | osid.room.RoomQuerySession | ||
Description |
This session provides methods for searching Rooms may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getRoomSearch | ||
Description |
Gets a room search. | ||
Return | osid.room.RoomSearch | the room search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomSearchOrder | ||
Description |
Gets a room search order. The | ||
Return | osid.room.RoomSearchOrder | the room search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomsBySearch | ||
Description |
Gets the room search results matching the given search. | ||
Parameters | osid.room.RoomQuery | roomQuery | the room query |
osid.room.RoomSearch | roomSearch | the room search | |
Return | osid.room.RoomSearchResults | the room search results | |
Errors | NULL_ARGUMENT | roomQuery or roomSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | roomQuery or roomSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.room.RoomQueryInspector | roomQueryInspector | a query inspector |
Return | osid.room.RoomQuery | the entry query | |
Errors | NULL_ARGUMENT | roomQueryInspector is null | |
UNSUPPORTED | roomQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |