OSID Specifications
room package
Version 3.1.0
room package
Version 3.1.0
| Interface | osid.room.RoomQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidTemporalQueryInspector | |||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.room.BuildingQueryInspector | ||
osid.room.CampusQueryInspector | |||
osid.room.FloorQueryInspector | |||
osid.room.RoomQueryInspector | |||
osid.room.RoomSearchResults | |||
osid.room.RoomSmartCampusSession | |||
osid.room.construction.RenovationQueryInspector | |||
osid.room.squatting.LeaseQueryInspector | |||
| Description |
The query inspector for examining room queries. | ||
| Method | getBuildingIdTerms | ||
| Description |
Gets the building | ||
| Return | osid.search.terms.IdTerm[] | the building Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBuildingTerms | ||
| Description |
Gets the building terms. | ||
| Return | osid.room.BuildingQueryInspector[] | the building terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFloorIdTerms | ||
| Description |
Gets the floor | ||
| Return | osid.search.terms.IdTerm[] | the floor Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFloorTerms | ||
| Description |
Gets the floor terms. | ||
| Return | osid.room.FloorQueryInspector[] | the floor terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnclosingRoomIdTerms | ||
| Description |
Gets the enclosing room | ||
| Return | osid.search.terms.IdTerm[] | the enclosing room Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnclosingRoomTerms | ||
| Description |
Gets the enclosing room terms. | ||
| Return | osid.room.RoomQueryInspector[] | the enclosing room terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubdivisionIdTerms | ||
| Description |
Gets the subdivision room | ||
| Return | osid.search.terms.IdTerm[] | the subdivision room Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubdivisionTerms | ||
| Description |
Gets the subdivision room terms. | ||
| Return | osid.room.RoomQueryInspector[] | the subdivision room terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDesignatedNameTerms | ||
| Description |
Gets the offical name terms. | ||
| Return | osid.search.terms.StringTerm[] | the name terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRoomNumberTerms | ||
| Description |
Gets the room building number terms. | ||
| Return | osid.search.terms.StringTerm[] | the room number terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCodeTerms | ||
| Description |
Gets the room code number terms. | ||
| Return | osid.search.terms.StringTerm[] | the room code terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAreaTerms | ||
| Description |
Gets the area terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the area terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOccupancyLimitTerms | ||
| Description |
Gets the occupancy limit terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the occupancy limit terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource 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 | getRoomQueryInspectorRecord | ||
| Description |
Gets the room query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | roomRecordType | a room record type |
| Return | osid.room.records.RoomQueryInspectorRecord | the room query inspector record | |
| Errors | NULL_ARGUMENT | roomRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(roomRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |