OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching maps. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchLocationId
Description

Sets the location Id for this query to match maps that have a related location.

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

Clears the location Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLocationQuery
Description

Tests if a LocationQuery is available.

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

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

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

Matches maps that have any location.

Parametersbooleanmatch true to match maps with any location, false to match maps with no location
CompliancemandatoryThis method must be implemented.
MethodclearLocationTerms
Description

Clears the location query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPathId
Description

Sets the path Id for this query to match maps containing paths.

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 maps that have any path.

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

Clears the path query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRouteId
Description

Sets the path Id for this query to match maps containing paths.

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.
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 maps that have any route.

Parametersbooleanmatch true to match maps with any route, false to match maps with no route
CompliancemandatoryThis method must be implemented.
MethodclearRouteTerms
Description

Clears the route query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorMapId
Description

Sets the map Id for this query to match maps that have the specified map as an ancestor.

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

Clears the ancestor map Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorMapQuery
Description

Tests if a MapQuery is available.

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

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

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

Matches maps with any ancestor.

Parametersbooleanmatch true to match maps with any ancestor, false to match root maps
CompliancemandatoryThis method must be implemented.
MethodclearAncestorMapTerms
Description

Clears the ancestor map query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantMapId
Description

Sets the map Id for this query to match maps that have the specified map as a descendant.

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

Clears the descendant map Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantMapQuery
Description

Tests if a MapQuery is available.

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

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

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

Matches maps with any descendant.

Parametersbooleanmatch true to match maps with any descendant, false to match leaf maps
CompliancemandatoryThis method must be implemented.
MethodclearDescendantMapTerms
Description

Clears the descendant map query terms.

CompliancemandatoryThis method must be implemented.
MethodgetMapQueryRecord
Description

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

Parametersosid.type.TypemapRecordTypea map record type
Returnosid.mapping.records.MapQueryRecordthe map query record
ErrorsNULL_ARGUMENT mapRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mapRecordType) is false
CompliancemandatoryThis method must be implemented.