OSID - osid.mapping.path.rules.ObstacleEnablerQuery Service Interface Definition

Interface	osid.mapping.path.rules.ObstacleEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.mapping.path.rules.ObstacleEnablerQuerySession`
	`osid.mapping.path.rules.ObstacleEnablerSearchSession`
	`osid.mapping.path.rules.ObstacleEnablerSmartMapSession`
Description	This is the query for searching obstacle enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledObstacleId
Description	Matches enablers mapped to an obstacle.
Parameters	`osid.id.Id`	`obstacleId`	the obstacle `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`obstacleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledObstacleIdTerms
Description	Clears the obstacle `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledObstacleQuery
Description	Tests if an `ObstacleQuery` is available.
Return	`boolean`		`true` if an obstacle query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledObstacleQuery
Description	Gets the query for an obstacle. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.path.ObstacleQuery`		the obstacle query
Errors	UNIMPLEMENTED		`supportsRuledObstacleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledObstacleQuery()` is `true` .
Method	matchAnyRuledObstacle
Description	Matches rules mapped to any obstacle.
Parameters	`boolean`	`match`	`true` for rules mapped to any obstacle, `false` to match rules mapped to no obstacles
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledObstacleTerms
Description	Clears the obstacle query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMapId
Description	Matches enablers mapped to a map.
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	getObstacleEnablerQueryRecord
Description	Gets the obstacle enabler query record corresponding to the given `ObstacleEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`obstacleEnablerRecordType`	an obstacle enabler record type
Return	`osid.mapping.path.rules.records.ObstacleEnablerQueryRecord`		the obstacle enabler query record
Errors	NULL_ARGUMENT		`obstacleEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(obstacleEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.