OSID Specifications
mapping path package
Version 3.1.0
mapping path package
Version 3.1.0
| Interface | osid.mapping.path.ObstacleQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidOperableQueryInspector | |||
| Used By | osid.mapping.path.ObstacleSearchResults | ||
osid.mapping.path.ObstacleSmartMapSession | |||
osid.mapping.path.rules.ObstacleEnablerQueryInspector | |||
| Description |
This is the query inspecto for examining obstacle queries. | ||
| 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 | getCoordinateTerms | ||
| Description |
Gets the coordinate query terms. | ||
| Return | osid.search.terms.CoordinateTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContainingSpatialUnitTerms | ||
| Description |
Gets the spatial unit inclusive query terms. | ||
| Return | osid.search.terms.SpatialUnitTerm[] | 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 | getObstacleQueryInspectorRecord | ||
| Description |
Gets the obstacle query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | obstacleRecordType | an obstacle record type |
| Return | osid.mapping.path.records.ObstacleQueryInspectorRecord | the obstacle query inspector record | |
| Errors | NULL_ARGUMENT | obstacleRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(obstacleRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |