OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
room package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.CampusQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining for campus queries. | ||
| 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 | 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 | 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 | getAncestorCampusIdTerms | ||
| Description |
Gets the ancestor campus | ||
| Return | osid.search.terms.IdTerm[] | the ancestor campus Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorCampusTerms | ||
| Description |
Gets the ancestor campus terms. | ||
| Return | osid.room.CampusQueryInspector[] | the ancestor campus terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCampusIdTerms | ||
| Description |
Gets the descendant campus | ||
| Return | osid.search.terms.IdTerm[] | the descendant campus Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCampusTerms | ||
| Description |
Gets the descendant campus terms. | ||
| Return | osid.room.CampusQueryInspector[] | the descendant campus terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCampusQueryInspectorRecord | ||
| Description |
Gets the campus query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | campusRecordType | a campus record type |
| Return | osid.room.records.CampusQueryInspectorRecord | the campus query inspector record | |
| Errors | NULL_ARGUMENT | campusRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(campusRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |