OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.BuildingSearch
Implementsosid.OsidSearch
Used Byosid.room.BuildingSearchSession
Description

The search interface for governing building searches.

MethodsearchAmongBuildings
Description

Execute this search among the given list of buildings.

Parametersosid.id.IdListbuildingIds list of buildings
ErrorsNULL_ARGUMENT buildingIds is null
Compliancemandatory This method must be implemented.
MethodorderBuildingResults
Description

Specify an ordering to the search results.

Parametersosid.room.BuildingSearchOrderbuildingSearchOrder building search order
ErrorsNULL_ARGUMENT buildingSearchOrder is null
UNSUPPORTED buildingSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBuildingSearchRecord
Description

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

Parametersosid.type.TypebuildingSearchRecordType a building search record type
Returnosid.room.records.BuildingSearchRecord the building search record
ErrorsNULL_ARGUMENT buildingSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(buildingSearchRecordType) is false
Compliancemandatory This method must be implemented.