Interface | osid.room.BuildingSearchSession | ||
---|---|---|---|
Implements | osid.room.BuildingQuerySession | ||
Description |
This session provides methods for searching Buildings may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getBuildingSearch | ||
Description |
Gets a building search. | ||
Return | osid.room.BuildingSearch | the building search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingSearchOrder | ||
Description |
Gets a building search order. The | ||
Return | osid.room.BuildingSearchOrder | the building search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.room.BuildingQuery | buildingQuery | the building query |
osid.room.BuildingSearch | buildingSearch | the building search | |
Return | osid.room.BuildingSearchResults | the building search results | |
Errors | NULL_ARGUMENT | buildingQuery or buildingSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | buildingQuery or buildingSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingQueryFromInspector | ||
Description |
Gets a building query from an inspector. The inspector
is available from a | ||
Parameters | osid.room.BuildingQueryInspector | buildingQueryInspector | a query inspector |
Return | osid.room.BuildingQuery | the building query | |
Errors | NULL_ARGUMENT | buildingQueryInspector is null | |
UNSUPPORTED | buildingQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |