OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
mapping package
Version 3.0.0
Release Candidate Preview
| Interface | osid.mapping.LocationQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidFederateableQueryInspector | |||
| Description |
This is the query inspector for searching locations. | ||
| Method | getCoordinateTerms | ||
| Description |
Gets the coordinate query terms. | ||
| Return | osid.search.terms.CoordinateTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainedSpatialUnitTerms | ||
| Description |
Gets the contained spatial unit query terms. | ||
| Return | osid.search.terms.SpatialUnitTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOverlappingSpatialUnitTerms | ||
| Description |
Gets the overlapping spatial unit query terms. | ||
| Return | osid.search.terms.SpatialUnitTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSpatialUnitTerms | ||
| Description |
Gets the spatial unit query terms. | ||
| Return | osid.search.terms.SpatialUnitTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteIdTerms | ||
| Description |
Gets the route | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteTerms | ||
| Description |
Gets the route query terms. | ||
| Return | osid.mapping.route.RouteQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathIdTerms | ||
| Description |
Gets the path | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathTerms | ||
| Description |
Gets the path query terms. | ||
| Return | osid.mapping.path.PathQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingLocationIdTerms | ||
| Description |
Gets the containing location | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingLocationTerms | ||
| Description |
Gets the containing location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainedLocationIdTerms | ||
| Description |
Gets the contained location | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainedLocationTerms | ||
| Description |
Gets the contained location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapIdTerms | ||
| Description |
Gets the map | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapTerms | ||
| Description |
Gets the map query terms. | ||
| Return | osid.mapping.MapQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationQueryInspectorRecord | ||
| Description |
Gets the location query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | locationRecordType | a location record type |
| Return | osid.mapping.records.LocationQueryInspectorRecord | the location query inspector record | |
| Errors | NULL_ARGUMENT | locationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(locationRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |