OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.FloorSearch
Implementsosid.OsidSearch
Used Byosid.room.FloorSearchSession
Description

The search interface for governing floor searches.

MethodsearchAmongFloors
Description

Execute this search among the given list of floors.

Parametersosid.id.IdListfloorIds list of floors
ErrorsNULL_ARGUMENT floorIds is null
Compliancemandatory This method must be implemented.
MethodorderFloorResults
Description

Specify an ordering to the search results.

Parametersosid.room.FloorSearchOrderfloorSearchOrder floor search order
ErrorsNULL_ARGUMENT floorSearchOrder is null
UNSUPPORTED floorSearchOrder is not of this service
Compliancemandatory This 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.TypefloorSearchRecordType a floor search record type
Returnosid.room.records.FloorSearchRecord the floor search record
ErrorsNULL_ARGUMENT floorSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(floorSearchRecordType) is false
Compliancemandatory This method must be implemented.