OSID Logo
OSID Specifications
room package
Version 3.0.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.IdListbuildingIdslist of buildings
ErrorsNULL_ARGUMENTbuildingIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBuildingResults
Description

Specify an ordering to the search results.

Parametersosid.room.BuildingSearchOrderbuildingSearchOrderbuilding search order
ErrorsNULL_ARGUMENTbuildingSearchOrder is null
UNSUPPORTEDbuildingSearchOrder is not of this service
CompliancemandatoryThis 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.TypebuildingSearchRecordTypea building search record type
Returnosid.room.records.BuildingSearchRecordthe building search record
ErrorsNULL_ARGUMENTbuildingSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(buildingSearchRecordType) is false
CompliancemandatoryThis method must be implemented.