OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRooms
Description

Gets the room list resulting from a search.

Returnosid.room.RoomListthe room list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRoomQueryInspector
Description

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

Returnosid.room.RoomQueryInspectorthe query inspector
CompliancemandatoryThis 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.TyperoomSearchRecordTypea room search record type
Returnosid.room.records.RoomSearchResultsRecordthe room search results record
ErrorsNULL_ARGUMENT roomSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(roomSearchRecordType) is false
CompliancemandatoryThis method must be implemented.