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

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

MethodgetFloors
Description

Gets the floor list resulting from a search.

Returnosid.room.FloorListthe floor list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetFloorQueryInspector
Description

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

Returnosid.room.FloorQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetFloorSearchResultsRecord
Description

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

Parametersosid.type.TypefloorSearchRecordTypea floor search record type
Returnosid.room.records.FloorSearchResultsRecordthe floor search results record
ErrorsNULL_ARGUMENT FloorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(floorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.