OSID Specifications
mapping path package
Version 3.1.0
mapping path package
Version 3.1.0
| Interface | osid.mapping.path.SignalQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
| Used By | osid.mapping.path.SignalSearchResults | ||
osid.mapping.path.SignalSmartMapSession | |||
osid.mapping.path.rules.SignalEnablerQueryInspector | |||
| Description |
This is the query inspector interface for examining signal 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 containing spatial unit query terms. | ||
| Return | osid.search.terms.SpatialUnitTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStateIdTerms | ||
| Description |
Gets the state | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStateTerms | ||
| Description |
Gets the state query terms. | ||
| Return | osid.process.StateQueryInspector[] | 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 | getSignalQueryInspectorRecord | ||
| Description |
Gets the signal query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | signalRecordType | a signal record type |
| Return | osid.mapping.path.records.SignalQueryInspectorRecord | the signal query inspector record | |
| Errors | NULL_ARGUMENT | signalRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(signalRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |