OSID - osid.mapping.path.ObstacleSmartMapSession Service Interface Definition

Interface	osid.mapping.path.ObstacleSmartMapSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `ObstacleQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Obstacles`. The obstacle may be sequenced using the `ObstacleSearchOrder` from this session. This `Map` has a default query that matches any obstacle and a default search order that specifies no sequencing. The queries may be examined using an `ObstacleQueryInspector`. The query may be modified by converting the inspector back to an `ObstacleQuery`.
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	canManageSmartMaps
Description	Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart map management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleQuery
Description	Gets an obstacle query.
Return	`osid.mapping.path.ObstacleQuery`		the obstacle query
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleSearchOrder
Description	Gets an obstacle search order.
Return	`osid.mapping.path.ObstacleSearchOrder`		the obstacle search order
Compliance	`mandatory`		This method must be implemented.
Method	applyObstacleQuery
Description	Applies an obstacle query to this map.
Parameters	`osid.mapping.path.ObstacleQuery`	`obstacleQuery`	the obstacle query
Errors	NULL_ARGUMENT		`obstacleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`obstacleQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecObstacleQuery
Description	Gets an obstacle query inspector for this map.
Return	`osid.mapping.path.ObstacleQueryInspector`		the obstacle query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyObstacleSequencing
Description	Applies an obstacle search order to this map.
Parameters	`osid.mapping.path.ObstacleSearchOrder`	`obstacleSearchOrder`	the obstacle search order
Errors	NULL_ARGUMENT		`obstacleSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`obstacleSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleQueryFromInspector
Description	Gets an obstacle query from an inspector.
Parameters	`osid.mapping.path.ObstacleQueryInspector`	`obstacleQueryInspector`	an obstacle query inspector
Return	`osid.mapping.path.ObstacleQuery`		the obstacle query
Errors	NULL_ARGUMENT		`obstacleQueryInspector` is `null`
Errors	UNSUPPORTED		`obstacleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.