OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.FloorSearch
Implementsosid.OsidSearch
Description

The search interface for governing floor searches.

MethodsearchAmongFloors
Description

Execute this search among the given list of floors.

Parametersosid.id.IdListfloorIdslist of floors
ErrorsNULL_ARGUMENT floorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderFloorResults
Description

Specify an ordering to the search results.

Parametersosid.room.FloorSearchOrderfloorSearchOrderfloor search order
ErrorsNULL_ARGUMENT floorSearchOrder is null
UNSUPPORTED floorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFloorSearchRecord
Description

Gets the dis[atch search 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.FloorSearchRecordthe floor search record
ErrorsNULL_ARGUMENT floorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(floorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.