Interface | osid.room.BuildingSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing building searches. | ||
Method | searchAmongBuildings | ||
Description |
Execute this search among the given list of buildings. | ||
Parameters | osid.id.IdList | buildingIds | list of buildings |
Errors | NULL_ARGUMENT | buildingIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderBuildingResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.room.BuildingSearchOrder | buildingSearchOrder | building search order |
Errors | NULL_ARGUMENT | buildingSearchOrder is null | |
UNSUPPORTED | buildingSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingSearchRecord | ||
Description |
Gets the building search record corresponding to the
given building search record | ||
Parameters | osid.type.Type | buildingSearchRecordType | a building search record type |
Return | osid.room.records.BuildingSearchRecord | the building search record | |
Errors | NULL_ARGUMENT | buildingSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(buildingSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |