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

Interface	osid.mapping.path.rules.ObstacleEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `ObstacleEnabler` to `Obstacle` mappings. An `Obstacle` with multiple `ObstacleEnablers` means any positive rule evaluation across the enablers result in an enabled `Obstacle.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated map view: All methods in this session operate, retrieve and pertain obstacle enabler defined explicitly in the current map federated map view: All methods in this session operate, retrieve and pertain to all obstacle enabler defined in this map and any other obstacle enabler implicitly available in this map through map inheritence.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupObstacleEnablerRules
Description	Tests if this user can perform lookups of obstacle enabler/obstacle mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeObstacleEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryObstacleEnablerRuleView
Description	A complete view of the `ObstacleEnabler` and `Obstacle` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedMapView
Description	Federates the view for methods in this session. A federated view will include obstacle enabler in maps which are children of this map in the map hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMapView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	getObstacleEnablerIdsForObstacle
Description	Gets the `ObstacleEnabler Id` associated with an `Obstacle.`
Parameters	`osid.id.Id`	`obstacleId`	`Id` of the `Obstacle`
Return	`osid.id.IdList`		the obstacle enabler `Ids`
Errors	NOT_FOUND		`obstacleId` is not found
	NULL_ARGUMENT		`obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleEnablersForObstacle
Description	Gets the `ObstacleEnabler` associated with an `Obstacle.`
Parameters	`osid.id.Id`	`obstacleId`	`Id` of the `Obstacle`
Return	`osid.mapping.path.rules.ObstacleEnablerList`		the obstacle enablers
Errors	NOT_FOUND		`obstacleId` is not found
	NULL_ARGUMENT		`obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleIdsForObstacleEnabler
Description	Gets the `Obstacle` `Ids` mapped to an `ObstacleEnabler.`
Parameters	`osid.id.Id`	`obstacleEnablerId`	`Id` of an `ObstacleEnabler`
Return	`osid.id.IdList`		list of obstacle `Ids`
Errors	NOT_FOUND		`obstacleEnablerId` is not found
	NULL_ARGUMENT		`obstacleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObstaclesForObstacleEnabler
Description	Gets the `Obstacles` mapped to an `ObstacleEnabler.`
Parameters	`osid.id.Id`	`obstacleEnablerId`	`Id` of an `ObstacleEnabler`
Return	`osid.mapping.path.ObstacleList`		list of obstacles
Errors	NOT_FOUND		`obstacleEnablerId` is not found
	NULL_ARGUMENT		`obstacleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.