OSID Logo
OSID Specifications
room package
Version 3.0.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.IdListroomIdslist of rooms
ErrorsNULL_ARGUMENTroomIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRoomResults
Description

Specify an ordering to the search results.

Parametersosid.room.RoomSearchOrderroomSearchOrderroom search order
ErrorsNULL_ARGUMENTroomSearchOrder is null
UNSUPPORTEDroomSearchOrder is not of this service
CompliancemandatoryThis 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.TyperoomSearchRecordTypea room search record type
Returnosid.room.records.RoomSearchRecordthe room search record
ErrorsNULL_ARGUMENTroomSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(roomSearchRecordType) is false
CompliancemandatoryThis method must be implemented.