OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.RoomSearch
Implementsosid.OsidSearch
Used Byosid.room.RoomSearchSession
Description

The search interface for governing room searches.

MethodsearchAmongRooms
Description

Execute this search among the given list of rooms.

Parametersosid.id.IdListroomIds list of rooms
ErrorsNULL_ARGUMENT roomIds is null
Compliancemandatory This method must be implemented.
MethodorderRoomResults
Description

Specify an ordering to the search results.

Parametersosid.room.RoomSearchOrderroomSearchOrder room search order
ErrorsNULL_ARGUMENT roomSearchOrder is null
UNSUPPORTED roomSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetRoomSearchRecord
Description

Gets the room search record corresponding to the given room search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TyperoomSearchRecordType a room search record type
Returnosid.room.records.RoomSearchRecord the room search record
ErrorsNULL_ARGUMENT roomSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(roomSearchRecordType) is false
Compliancemandatory This method must be implemented.