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

Interface	osid.mapping.path.PathQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching paths. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCoordinate
Description	Matches paths overlapping with the specified `Coordinate.`
Parameters	`osid.mapping.Coordinate`	`coordinate`	a coordinate
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`coordinate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCoordinateTerms
Description	Clears the coordinate query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverlappingSpatialUnit
Description	Matches paths overlapping with the specified `SpatialUnit.`
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	a spatial unit
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverlappingSpatialUnit
Description	Matches paths that have any overlapping spatial unit.
Parameters	`boolean`	`match`	`true` to match paths with any spatial dimension, `false` to match paths with no spatial dimensions
Compliance	`mandatory`		This method must be implemented.
Method	clearOverlappingSpatialUnitTerms
Description	Clears the spatial unit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAlongLocationIds
Description	Sets the location `Ids` for this query to match paths including 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	matchIntersectingPathId
Description	Sets the path `Id` for this query to match paths intersecting with another 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	clearIntersectingPathIdTerms
Description	Clears the intersecting path `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectingPathQuery
Description	Tests if a `PathQuery` is available for intersecting paths,
Return	`boolean`		`true` if a path query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectingPathQuery
Description	Gets the query for an intersecting path, Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.path.PathQuery`		the path query
Errors	UNIMPLEMENTED		`supportsIntersectingPathQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsIntersectingPathQuery()` is `true.`
Method	matchAnyIntersectingPath
Description	Matches paths with any intersecting path,
Parameters	`boolean`	`match`	`true` to match paths with any intersecting path, `false` to match paths with no intersecting path
Compliance	`mandatory`		This method must be implemented.
Method	clearIntersectingPathTerms
Description	Clears the intersecting path query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationId
Description	Sets the location `Id` for this query to match paths that pass through locations.
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 go through any location.
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	matchRouteId
Description	Sets the route `Id` for this query to match paths used in a route.
Parameters	`osid.id.Id`	`routeId`	a route `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`routeId` 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	matchAnyRoute
Description	Matches paths that are used in any route.
Parameters	`boolean`	`match`	`true` to match paths in any route, `false` to match paths used in no route
Compliance	`mandatory`		This method must be implemented.
Method	clearRouteTerms
Description	Clears the route query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMapId
Description	Sets the map `Id` for this query to match paths 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	getPathQueryRecord
Description	Gets the path query record corresponding to the given `Path` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`pathRecordType`	a path record type
Return	`osid.mapping.path.records.PathQueryRecord`		the path query 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.