OSID - osid.mapping.path.PathQueryInspector Service Interface Definition

Interface	osid.mapping.path.PathQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Used By	`osid.mapping.LocationQueryInspector`
	`osid.mapping.MapQueryInspector`
	`osid.mapping.path.IntersectionQueryInspector`
	`osid.mapping.path.ObstacleQueryInspector`
	`osid.mapping.path.PathQueryInspector`
	`osid.mapping.path.PathSearchResults`
	`osid.mapping.path.PathSmartMapSession`
	`osid.mapping.path.SignalQueryInspector`
	`osid.mapping.path.SpeedZoneQueryInspector`
	`osid.mapping.route.RouteQueryInspector`
	show 1 more…
`osid.mapping.route.RouteSegmentQueryInspector`
Description	This is the query inspector for examining path queries. Like all `OsidQueryInspectors`, `PathQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getCoordinateTerms
Description	Gets the coordinate query terms.
Return	`osid.search.terms.CoordinateTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverlappingSpatialUnitTerms
Description	Gets the spatial unit query terms.
Return	`osid.search.terms.SpatialUnitTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAlongLocationIdsTerms
Description	Gets the along location `Ids` query terms.
Return	`osid.search.terms.IdSetTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectingPathIdTerms
Description	Gets the intersecting path `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectingPathTerms
Description	Gets the intersecting path query terms.
Return	`osid.mapping.path.PathQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getLocationIdTerms
Description	Gets the location `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getLocationTerms
Description	Gets the location query terms.
Return	`osid.mapping.LocationQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRouteIdTerms
Description	Gets the route `Id` query terms.
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	getMapIdTerms
Description	Gets the map `Id` query terms.
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	getPathQueryInspectorRecord
Description	Gets the path query inspector record corresponding to the given `Path` record `Type`.
Parameters	`osid.type.Type`	`pathRecordType`	a path record type
Return	`osid.mapping.path.records.PathQueryInspectorRecord`		the path query inspector record
Errors	NULL_ARGUMENT		`pathRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(pathRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.