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

Interface	osid.mapping.route.RouteQuery
Implements	`osid.OsidRelationshipQuery`
Implements	`osid.OsidAggregateableQuery`
Description	This is the query for searching routes. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchStartingLocationId
Description	Sets the location `Id` for this query to match routes with a starting location.
Parameters	`osid.id.Id`	`locationId`	the location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStartingLocationIdTerms
Description	Clears the starting location `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartingLocationQuery
Description	Tests if a `LocationQuery` is available for a starting location.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStartingLocationQuery
Description	Gets the query for a starting location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsStartingLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartingLocationQuery()` is `true.`
Method	clearStartingLocationTerms
Description	Clears the starting location query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEndingLocationId
Description	Sets the location `Id` for this query to match routes with an ending location.
Parameters	`osid.id.Id`	`locationId`	the location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEndingLocationIdTerms
Description	Clears the ending location `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndingLocationQuery
Description	Tests if a `LocationQuery` is available for an ending location.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndingLocationQuery
Description	Gets the query for an ending location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsEndingLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndingLocationQuery()` is `true.`
Method	clearEndingLocationTerms
Description	Clears the ending location query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAlongLocationIds
Description	Sets the location `Id` for this query to match routes along all the given locations.
Parameters	`osid.id.Id[]`	`locationIds`	the location `Ids`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAlongLocationIdsTerms
Description	Clears the along location `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistance
Description	Matches routes that have distances within the specified range inclusive.
Parameters	`osid.mapping.Distance`	`from`	starting range
	`osid.mapping.Distance`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDistance
Description	Matches routes that has any distance assigned or calculated.
Parameters	`boolean`	`match`	`true` to match routes with any distance, `false` to match routes with no distance
Compliance	`mandatory`		This method must be implemented.
Method	clearDistanceTerms
Description	Clears the distance query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchETA
Description	Matches routes that have the specified estimated travel time inclusive.
Parameters	`osid.calendaring.Duration`	`from`	starting range
	`osid.calendaring.Duration`	`to`	ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyETA
Description	Matches routes that has any estimated time assigned or calculated.
Parameters	`boolean`	`match`	`true` to match routes with any eta, `false` to match routes with no eta
Compliance	`mandatory`		This method must be implemented.
Method	clearETATerms
Description	Clears the ETA query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationId
Description	Sets the location `Id` for this query to match routes through a location.
Parameters	`osid.id.Id`	`locationId`	the location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationIdTerms
Description	Clears the location `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationQuery
Description	Tests if a `LocationQuery` is available.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQuery
Description	Gets the query for a location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationQuery()` is `true.`
Method	matchAnyLocation
Description	Matches routes that has any location along the route, exclusive of the endpoints.
Parameters	`boolean`	`match`	`true` to match routes with any location, `false` to match routes with no location
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationTerms
Description	Clears the location query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPathId
Description	Sets the path `Id` for this query to match routes using a designated path.
Parameters	`osid.id.Id`	`pathId`	the path `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`pathId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPathIdTerms
Description	Clears the path `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathQuery
Description	Tests if a `PathQuery` is available.
Return	`boolean`		`true` if a path query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPathQuery
Description	Gets the query for a path. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.path.PathQuery`		the path query
Errors	UNIMPLEMENTED		`supportsPathQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPathQuery()` is `true.`
Method	matchAnyPath
Description	Matches routes using any designated path.
Parameters	`boolean`	`match`	`true` to match routes with any path `false` to match routes with no path
Compliance	`mandatory`		This method must be implemented.
Method	clearPathTerms
Description	Clears the path query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMapId
Description	Sets the map `Id` for this query to match routes assigned to maps.
Parameters	`osid.id.Id`	`mapId`	the map `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`mapId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMapIdTerms
Description	Clears the map `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapQuery
Description	Tests if a `MapQuery` is available.
Return	`boolean`		`true` if a map query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMapQuery
Description	Gets the query for a map. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.MapQuery`		the map query
Errors	UNIMPLEMENTED		`supportsMapQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapQuery()` is `true.`
Method	clearMapTerms
Description	Clears the map query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRouteQueryRecord
Description	Gets the route query record corresponding to the given `Route` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`routeRecordType`	a route record type
Return	`osid.mapping.route.records.RouteQueryRecord`		the route query 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.