OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.LocationQuery
Implementsosid.OsidObjectQuery
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.

MethodmatchCoordinate
Description

Matches locations at the specified Coordinate.

Parametersosid.mapping.Coordinatecoordinatea coordinate
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT coordinate is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCoordinate
Description

Matches locations that have any coordinate assignment.

Parametersbooleanmatch true to match locations with any coordinate, false to match locations with no coordinates
CompliancemandatoryThis method must be implemented.
MethodclearCoordinateTerms
Description

Clears the coordinate query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainedSpatialUnit
Description

Matches locations containing the specified SpatialUnit.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT spatialUnit is null
CompliancemandatoryThis method must be implemented.
MethodclearContainedSpatialUnitTerms
Description

Clears the spatial unit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverlappingSpatialUnit
Description

Matches locations overlapping with the specified SpatialUnit.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT spatialUnit is null
CompliancemandatoryThis method must be implemented.
MethodclearOverlappingSpatialUnitTerms
Description

Clears the overlapping spatial unit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAnySpatialUnit
Description

Matches locations that have any spatial unit assignment.

Parametersbooleanmatch true to match locations with any boundary, false to match locations with no boundaries
CompliancemandatoryThis method must be implemented.
MethodclearSpatialUnitTerms
Description

Clears the spatial unit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRouteId
Description

Sets the route Id for this query to match locations along the given route.

Parametersosid.id.IdrouteIdthe route Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT routeId is null
CompliancemandatoryThis method must be implemented.
MethodclearRouteIdTerms
Description

Clears the route Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRouteQuery
Description

Tests if a RouteQuery is available.

Returnboolean true if a route query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRouteQuery
Description

Gets the query for a route. Multiple retrievals produce a nested OR term.

Returnosid.mapping.route.RouteQuerythe route query
ErrorsUNIMPLEMENTED supportsRouteQuery() is false
ComplianceoptionalThis method must be implemented if supportsRouteQuery() is true.
MethodmatchAnyRoute
Description

Matches locations that are used on any route.

Parametersbooleanmatch true to match locations on any route, false to match locations on no routes
CompliancemandatoryThis method must be implemented.
MethodclearRouteTerms
Description

Clears the route query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPathId
Description

Sets the path Id for this query to match locations along the given path.

Parametersosid.id.IdpathIdthe path Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT pathId is null
CompliancemandatoryThis method must be implemented.
MethodclearPathIdTerms
Description

Clears the path Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPathQuery
Description

Tests if a PathQuery is available.

Returnboolean true if a path query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPathQuery
Description

Gets the query for a path. Multiple retrievals produce a nested OR term.

Returnosid.mapping.path.PathQuerythe path query
ErrorsUNIMPLEMENTED supportsPathQuery() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() is true.
MethodmatchAnyPath
Description

Matches locations that exist along any path.

Parametersbooleanmatch true to match locations on any path, false to match locations on no path
CompliancemandatoryThis method must be implemented.
MethodclearPathTerms
Description

Clears the path query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainingLocationId
Description

Sets the location Id for this query to match locations contained within the given location.

Parametersosid.id.IdlocationIda location Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT locationId is null
CompliancemandatoryThis method must be implemented.
MethodclearContainingLocationIdTerms
Description

Clears the pcontaining location Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsContainingLocationQuery
Description

Tests if a LocationQuery is available.

Returnboolean true if a location query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetContainingLocationQuery
Description

Gets the query for a parent location. Multiple retrievals produce a nested OR term.

Returnosid.mapping.LocationQuerythe location query
ErrorsUNIMPLEMENTED supportsContainingLocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsContainingLocationQuery() is true.
MethodmatchAnyContainingLocation
Description

Matches locations that have any ancestor.

Parametersbooleanmatch true to match locations with any parent location, false to match root locations
CompliancemandatoryThis method must be implemented.
MethodclearContainingLocationTerms
Description

Clears the containing location query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainedLocationId
Description

Sets the location Id for this query to match locations containing the given location.

Parametersosid.id.IdlocationIda location Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT locationId is null
CompliancemandatoryThis method must be implemented.
MethodclearContainedLocationIdTerms
Description

Clears the contained location Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsContainedLocationQuery
Description

Tests if a LocationQuery is available.

Returnboolean true if a location query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetContainedLocationQuery
Description

Gets the query for a contained location. Multiple retrievals produce a nested OR term.

Returnosid.mapping.LocationQuerythe location query
ErrorsUNIMPLEMENTED supportsContainedLocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsContainedLocationQuery() is true.
MethodmatchAnyContainedLocation
Description

Matches locations that have any children.

Parametersbooleanmatch true to match locations containing any other location, false to match empty locations
CompliancemandatoryThis method must be implemented.
MethodclearContainedLocationTerms
Description

Clears the contained location query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMapId
Description

Sets the map Id for this query.

Parametersosid.id.IdmapIdthe map Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT mapId is null
CompliancemandatoryThis method must be implemented.
MethodclearMapIdTerms
Description

Clears the map Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsMapQuery
Description

Tests if a MapQuery is available.

Returnboolean true if a map query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMapQuery
Description

Gets the query for a map. Multiple retrievals produce a nested OR term.

Returnosid.mapping.MapQuerythe map query
ErrorsUNIMPLEMENTED supportsMapQuery() is false
ComplianceoptionalThis method must be implemented if supportsMapQuery() is true.
MethodclearMapTerms
Description

Clears the map query terms.

CompliancemandatoryThis method must be implemented.
MethodgetLocationQueryRecord
Description

Gets the location query record corresponding to the given Location record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypelocationRecordTypea location record type
Returnosid.mapping.records.LocationQueryRecordthe location query record
ErrorsNULL_ARGUMENT locationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(locationRecordType) is false
CompliancemandatoryThis method must be implemented.