OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.RoomSearchResults
Implementsosid.OsidSearchResults
Used Byosid.room.RoomSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetRooms
Description

Gets the room list resulting from a search.

Returnosid.room.RoomList the room list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetRoomQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.room.RoomQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetRoomSearchResultsRecord
Description

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

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