Interface | osid.room.RoomSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRooms | ||
Description |
Gets the room list resulting from a search. | ||
Return | osid.room.RoomList | the room list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.room.RoomQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomSearchResultsRecord | ||
Description |
Gets the room search results record corresponding to
the given room search record | ||
Parameters | osid.type.Type | roomSearchRecordType | a room search record type |
Return | osid.room.records.RoomSearchResultsRecord | the room search results record | |
Errors | NULL_ARGUMENT | roomSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(roomSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |