OSID - osid.mapping.MapQuery Service Interface Definition

Interface	osid.mapping.MapQuery
Implements	`osid.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.`
Method	matchLocationId
Description	Sets the location `Id` for this query to match maps that have a related location.
Parameters	`osid.id.Id`	`locationId`	a location `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for 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 maps that have any location.
Parameters	`boolean`	`match`	`true` to match maps with any location, `false` to match maps 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	matchPathId
Description	Sets the path `Id` for this query to match maps containing paths.
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 maps that have any path.
Parameters	`boolean`	`match`	`true` to match maps with any path, `false` to match maps with 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	matchRouteId
Description	Sets the path `Id` for this query to match maps containing paths.
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	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 maps that have any route.
Parameters	`boolean`	`match`	`true` to match maps with any route, `false` to match maps with 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	matchAncestorMapId
Description	Sets the map `Id` for this query to match maps that have the specified map as an ancestor.
Parameters	`osid.id.Id`	`mapId`	a map `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`mapId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorMapIdTerms
Description	Clears the ancestor map `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorMapQuery
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	getAncestorMapQuery
Description	Gets the query for a map. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.MapQuery`		the map query
Errors	UNIMPLEMENTED		`supportsAncestorMapQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorMapQuery()` is `true.`
Method	matchAnyAncestorMap
Description	Matches maps with any ancestor.
Parameters	`boolean`	`match`	`true` to match maps with any ancestor, `false` to match root maps
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorMapTerms
Description	Clears the ancestor map query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantMapId
Description	Sets the map `Id` for this query to match maps that have the specified map as a descendant.
Parameters	`osid.id.Id`	`mapId`	a map `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`mapId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantMapIdTerms
Description	Clears the descendant map `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantMapQuery
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	getDescendantMapQuery
Description	Gets the query for a map. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.MapQuery`		the map query
Errors	UNIMPLEMENTED		`supportsDescendantMapQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantMapQuery()` is `true.`
Method	matchAnyDescendantMap
Description	Matches maps with any descendant.
Parameters	`boolean`	`match`	`true` to match maps with any descendant, `false` to match leaf maps
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantMapTerms
Description	Clears the descendant map query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getMapQueryRecord
Description	Gets the map query record corresponding to the given `Map` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`mapRecordType`	a map record type
Return	`osid.mapping.records.MapQueryRecord`		the map query record
Errors	NULL_ARGUMENT		`mapRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(mapRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.