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

Interface	osid.mapping.path.SignalSmartMapSession
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. A `SignalQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Signals`. The signals may be sequenced using the `SignalSearchOrder` from this session. This `Map` has a default query that matches any signal and a default search order that specifies no sequencing. The queries may be examined using a `SignalQueryInspector`. The query may be modified by converting the inspector back to a `SignalQuery` .
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	getSignalQuery
Description	Gets a signal query.
Return	`osid.mapping.path.SignalQuery`		the signal query
Compliance	`mandatory`		This method must be implemented.
Method	getSignalSearchOrder
Description	Gets a signal search order.
Return	`osid.mapping.path.SignalSearchOrder`		the signal search order
Compliance	`mandatory`		the signal search order
Method	applySignalQuery
Description	Applies a signal query to this map.
Parameters	`osid.mapping.path.SignalQuery`	`signalQuery`	the signal query
Errors	NULL_ARGUMENT		`signalQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`signalQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecSignalQuery
Description	Gets a signal query inspector for this map.
Return	`osid.mapping.path.SignalQueryInspector`		the signal query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySignalSequencing
Description	Applies a signal search order to this map.
Parameters	`osid.mapping.path.SignalSearchOrder`	`signalSearchOrder`	the signal search order
Errors	NULL_ARGUMENT		`signalSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`signalSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSignalQueryFromInspector
Description	Gets a signal query from an inspector.
Parameters	`osid.mapping.path.SignalQueryInspector`	`signalQueryInspector`	a signal query inspector
Return	`osid.mapping.path.SignalQuery`		the signal query
Errors	NULL_ARGUMENT		`signalQueryInspector` is `null`
Errors	UNSUPPORTED		`signalQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.