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

Interface	osid.mapping.path.ObstacleQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidOperableQuery`
Used By	`osid.mapping.path.ObstacleQuerySession`
	`osid.mapping.path.ObstacleSearchSession`
	`osid.mapping.path.ObstacleSmartMapSession`
	`osid.mapping.path.rules.ObstacleEnablerQuery`
Description	This is the query for searching obstacles. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchPathId
Description	Sets the path `Id` for this query to match obstacles along the given 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	clearPathTerms
Description	Clears the path query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCoordinate
Description	Matches obstacles 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	matchContainingSpatialUnit
Description	Matches obstacles within 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	clearContainingSpatialUnitTerms
Description	Clears the spatial unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMapId
Description	Sets the map `Id` for this query.
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	getObstacleQueryRecord
Description	Gets the obstacle query record corresponding to the given `Obstacle` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`obstacleRecordType`	an obstacle record type
Return	`osid.mapping.path.records.ObstacleQueryRecord`		the obstacle query record
Errors	NULL_ARGUMENT		`obstacleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(obstacleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.