OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
room package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.BuildingQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidTemporalQueryInspector | |||
| Description |
This is the query inspector for examining for building queries. | ||
| Method | getAddressIdTerms | ||
| Description |
Gets the address | ||
| Return | osid.search.terms.IdTerm[] | the address Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressTerms | ||
| Description |
Gets the address terms. | ||
| Return | osid.contact.AddressQueryInspector[] | the address terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfficialNameTerms | ||
| Description |
Gets the offical name terms. | ||
| Return | osid.search.terms.StringTerm[] | the name terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNumberTerms | ||
| Description |
Gets the building number terms. | ||
| Return | osid.search.terms.StringTerm[] | the number terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnclosingBuildingIdTerms | ||
| Description |
Gets the enclosing building | ||
| Return | osid.search.terms.IdTerm[] | the building Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnclosingBuildingTerms | ||
| Description |
Gets the enclosing building terms. | ||
| Return | osid.room.BuildingQueryInspector[] | the building terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGrossAreaTerms | ||
| Description |
Gets the gross area terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the gross area terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRoomIdTerms | ||
| Description |
Gets the room | ||
| Return | osid.search.terms.IdTerm[] | the room Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRoomTerms | ||
| Description |
Gets the room terms. | ||
| Return | osid.room.RoomQueryInspector[] | the room terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCampusIdTerms | ||
| Description |
Gets the campus | ||
| Return | osid.search.terms.IdTerm[] | the campus Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCampusTerms | ||
| Description |
Gets the campus terms. | ||
| Return | osid.room.CampusQueryInspector[] | the campus terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBuildingQueryInspectorRecord | ||
| Description |
Gets the building query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | buildingRecordType | a building record type |
| Return | osid.room.records.BuildingQueryInspectorRecord | the building query inspector record | |
| Errors | NULL_ARGUMENT | buildingRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(buildingRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |