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

Interface	osid.mapping.path.rules.SignalEnablerSmartMapSession
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 maps. A `SignalEnablerQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of signal enablers. The signal enabler may be sequenced using the `SignalEnablerSearchOrder` from this session. This `Map` has a default query that matches any signal enabler and a default search order that specifies no sequencing. The queries may be examined using a `SignalEnablerQueryInspector`. The query may be modified by converting the inspector back to a `SignalEnablerQuery`.
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	getSignalEnablerQuery
Description	Gets a signal enabler query.
Return	`osid.mapping.path.rules.SignalEnablerQuery`		the signal enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablerSearchOrder
Description	Gets a signal enabler search order.
Return	`osid.mapping.path.rules.SignalEnablerSearchOrder`		the signal enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applySignalEnablerQuery
Description	Applies a signal enabler query to this map.
Parameters	`osid.mapping.path.rules.SignalEnablerQuery`	`signalEnablerQuery`	the signal enabler query
Errors	NULL_ARGUMENT		`signalEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`signalEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSignalEnablerQuery
Description	Gets a signal enabler query inspector for this map.
Return	`osid.mapping.path.rules.SignalEnablerQueryInspector`		the signal enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySignalEnablerSequencing
Description	Applies a signal enabler search order to this map.
Parameters	`osid.mapping.path.rules.SignalEnablerSearchOrder`	`signalEnablerSearchOrder`	the signal enabler search order
Errors	NULL_ARGUMENT		`signalEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`signalEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablerQueryFromInspector
Description	Gets a signal enabler query from an inspector.
Parameters	`osid.mapping.path.rules.SignalEnablerQueryInspector`	`signalEnablerQueryInspector`	a signal enabler query inspector
Return	`osid.mapping.path.rules.SignalEnablerQuery`		the signal enabler query
Errors	NULL_ARGUMENT		`signalEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`signalEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.