Interface | osid.room.RoomSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing room searches. | ||
Method | searchAmongRooms | ||
Description |
Execute this search among the given list of rooms. | ||
Parameters | osid.id.IdList | roomIds | list of rooms |
Errors | NULL_ARGUMENT | roomIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRoomResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.room.RoomSearchOrder | roomSearchOrder | room search order |
Errors | NULL_ARGUMENT | roomSearchOrder is null | |
UNSUPPORTED | roomSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoomSearchRecord | ||
Description |
Gets the room search record corresponding to the given
room search record | ||
Parameters | osid.type.Type | roomSearchRecordType | a room search record type |
Return | osid.room.records.RoomSearchRecord | the room search 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. |