OSID - osid.mapping.LocationQuery Service Interface Definition

Interface	osid.mapping.LocationQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidFederateableQuery`
Description	This is the query for searching locations. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCoordinate
Description	Matches locations at 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	matchAnyCoordinate
Description	Matches locations that have any coordinate assignment.
Parameters	`boolean`	`match`	`true` to match locations with any coordinate, `false` to match locations with no coordinates
Compliance	`mandatory`		This method must be implemented.
Method	clearCoordinateTerms
Description	Clears the coordinate query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainedSpatialUnit
Description	Matches locations containing 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	clearContainedSpatialUnitTerms
Description	Clears the spatial unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverlappingSpatialUnit
Description	Matches locations 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	clearOverlappingSpatialUnitTerms
Description	Clears the overlapping spatial unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySpatialUnit
Description	Matches locations that have any spatial unit assignment.
Parameters	`boolean`	`match`	`true` to match locations with any boundary, `false` to match locations with no boundaries
Compliance	`mandatory`		This method must be implemented.
Method	clearSpatialUnitTerms
Description	Clears the spatial unit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRouteId
Description	Sets the route `Id` for this query to match locations along the given route.
Parameters	`osid.id.Id`	`routeId`	the 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 locations that are used on any route.
Parameters	`boolean`	`match`	`true` to match locations on any route, `false` to match locations on no routes
Compliance	`mandatory`		This method must be implemented.
Method	clearRouteTerms
Description	Clears the route query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPathId
Description	Sets the path `Id` for this query to match locations 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	matchAnyPath
Description	Matches locations that exist along any path.
Parameters	`boolean`	`match`	`true` to match locations on any path, `false` to match locations on 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	matchContainingLocationId
Description	Sets the location `Id` for this query to match locations contained within the given location.
Parameters	`osid.id.Id`	`locationId`	a 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	clearContainingLocationIdTerms
Description	Clears the pcontaining location `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainingLocationQuery
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	getContainingLocationQuery
Description	Gets the query for a parent location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsContainingLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainingLocationQuery()` is `true.`
Method	matchAnyContainingLocation
Description	Matches locations that have any ancestor.
Parameters	`boolean`	`match`	`true` to match locations with any parent location, `false` to match root locations
Compliance	`mandatory`		This method must be implemented.
Method	clearContainingLocationTerms
Description	Clears the containing location query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainedLocationId
Description	Sets the location `Id` for this query to match locations containing the given location.
Parameters	`osid.id.Id`	`locationId`	a 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	clearContainedLocationIdTerms
Description	Clears the contained location `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainedLocationQuery
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	getContainedLocationQuery
Description	Gets the query for a contained location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsContainedLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainedLocationQuery()` is `true.`
Method	matchAnyContainedLocation
Description	Matches locations that have any children.
Parameters	`boolean`	`match`	`true` to match locations containing any other location, `false` to match empty locations
Compliance	`mandatory`		This method must be implemented.
Method	clearContainedLocationTerms
Description	Clears the contained location query 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	getLocationQueryRecord
Description	Gets the location query record corresponding to the given `Location` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`locationRecordType`	a location record type
Return	`osid.mapping.records.LocationQueryRecord`		the location query record
Errors	NULL_ARGUMENT		`locationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(locationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.