OSID - osid.mapping.route.RouteQueryInspector Service Interface Definition

Interface	osid.mapping.route.RouteQueryInspector
Implements	`osid.OsidRelationshipQueryInspector`
Implements	`osid.OsidAggregateableQueryInspector`
Used By	`osid.mapping.LocationQueryInspector`
	`osid.mapping.MapQueryInspector`
	`osid.mapping.path.PathQueryInspector`
	`osid.mapping.route.RouteSearchResults`
	`osid.mapping.route.RouteSegmentQueryInspector`
	`osid.mapping.route.RouteSmartMapSession`
Description	This is the query inspector for examining route queries.
Method	getStartingLocationIdTerms
Description	Gets the starting location `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStartingLocationTerms
Description	Gets the starting location query terms.
Return	`osid.mapping.LocationQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEndingLocationIdTerms
Description	Gets the ending location `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEndingLocationTerms
Description	Gets the ending location query terms.
Return	`osid.mapping.LocationQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAlongLocationIdsTerms
Description	Gets the along location `Id` query terms.
Return	`osid.search.terms.IdSetTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDistanceTerms
Description	Gets the distance query terms.
Return	`osid.search.terms.DistanceRangeTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getETATerms
Description	Gets the ETA query terms.
Return	`osid.search.terms.DurationRangeTerm[]`		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	getPathIdTerms
Description	Gets the path `Id` query terms.
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	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	getRouteQueryInspectorRecord
Description	Gets the route query inspector record corresponding to the given `Route` record `Type`.
Parameters	`osid.type.Type`	`routeRecordType`	a route record type
Return	`osid.mapping.route.records.RouteQueryInspectorRecord`		the route query inspector record
Errors	NULL_ARGUMENT		`routeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(routeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.