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

Interface	osid.mapping.path.rules.SpeedZoneEnablerSmartMapSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic map. a `SpeedZoneEnablerQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of speed zone enablers. The speed zone enablers may be sequenced using the `SpeedZoneEnablerSearchOrder` from this session. This `Map` has a default query that matches any speed zone enabler and a default search order that specifies no sequencing. The queries may be examined using a `SpeedZoneEnablerQueryInspector`. The query may be modified by converting the inspector back to a `SpeedZoneEnablerQuery`.
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 map. 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	getSpeedZoneEnablerQuery
Description	Gets a speed zone enabler query.
Return	`osid.mapping.path.rules.SpeedZoneEnablerQuery`		the speed zone enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablerSearchOrder
Description	Gets a speed zone enabler search order.
Return	`osid.mapping.path.rules.SpeedZoneEnablerSearchOrder`		the speed zone enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applySpeedZoneEnablerQuery
Description	Applies a speed zone enabler query to this map.
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerQuery`	`speedZoneEnablerQuery`	the speed zone enabler query
Errors	NULL_ARGUMENT		`speedZoneEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`speedZoneEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSpeedZoneEnablerQuery
Description	Gets a speed zone enabler query inspector for this map.
Return	`osid.mapping.path.rules.SpeedZoneEnablerQueryInspector`		the speed zone enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySpeedZoneEnablerSequencing
Description	Applies a speed zone enabler search order to this map.
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerSearchOrder`	`speedZoneEnablerSearchOrder`	the speed zone enabler search order
Errors	NULL_ARGUMENT		`speedZoneEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`speedZoneEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablerQueryFromInspector
Description	Gets a speed zone enabler query from an inspector.
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerQueryInspector`	`speedZoneEnablerQueryInspector`	a speed zone enabler query inspector
Return	`osid.mapping.path.rules.SpeedZoneEnablerQuery`		the speed zone enabler query
Errors	NULL_ARGUMENT		`speedZoneEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`speedZoneEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.