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

Interface	osid.mapping.route.RouteSegmentQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching route segments. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchStartingInstructions
Description	Matches the starting instructions for the segment.
Parameters	`string`	`startingInstructions`	the starting instructions
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`startingInstructions` is not of `stringMatchType`
	NULL_ARGUMENT		`startingInstructions` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStartingInstructions
Description	Matches segments that have any starting instructions.
Parameters	`boolean`	`match`	`true` to match segments with any starting instructions, `false` to match segments with no starting instriuctions
Compliance	`mandatory`		This method must be implemented.
Method	clearStartingInstructionsTerms
Description	Clears the starting instruction query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEndingInstructions
Description	Matches the ending instructions for the segment.
Parameters	`string`	`endingInstructions`	the ending instructions
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`endingInstructions` is not of `stringMatchType`
	NULL_ARGUMENT		`endingInstructions` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyEndingInstructions
Description	Matches segments that have any ending instructions.
Parameters	`boolean`	`match`	`true` to match segments with any ending instructions, `false` to match segments with no ending instriuctions
Compliance	`mandatory`		This method must be implemented.
Method	clearEndingInstructionsTerms
Description	Clears the ending instruction query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistance
Description	Matches route segments with distances in the specified range.
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` ie less than `from`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
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 route segments with estimated ravel times in the specified range.
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` ie less than `from`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearETATerms
Description	Clears the ETA query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPathId
Description	Sets the path `Id` for this query to match route segments containing paths.
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 route segments that have any path.
Parameters	`boolean`	`match`	`true` to match route segments with any path, `false` to match route segments 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	matchRouteId
Description	Sets the path `Id` for this query to match route segments containing paths.
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	clearRouteIdTerms
Description	Clears the route `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteQuery
Description	Tests if a `RouteQuery` is available.
Return	`boolean`		`true` if a route query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRouteQuery
Description	Gets the query for a route. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.route.RouteQuery`		the route query
Errors	UNIMPLEMENTED		`supportsRouteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteQuery()` is `true`.
Method	clearRouteTerms
Description	Clears the route query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentQueryRecord
Description	Gets the route segment query record corresponding to the given `RouteSegment` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`routeSegmentRecordType`	a route segment record type
Return	`osid.mapping.route.records.RouteSegmentQueryRecord`		the route segment query record
Errors	NULL_ARGUMENT		`routeSegmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(routeSegmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.