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

Interface	osid.mapping.path.rules.SignalEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session provides methods to retrieve `SignalEnabler` to `Signal` mappings. A `Signal` with multiple `SignalEnablers` means any positive rule evaluation across the enablers result in an enabled `Signal` . 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 signal enabler defined explicitly in the current map federated map view: All methods in this session operate, retrieve and pertain to all signal enabler defined in this map and any other signal 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	canLookupSignalEnablerRules
Description	Tests if this user can perform lookups of signal enabler/signal 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	useComparativeSignalEnablerRuleView
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	usePlenarySignalEnablerRuleView
Description	A complete view of the `SignalEnabler` and `Signal` 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 signal 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	getSignalEnablerIdsForSignal
Description	Gets the `SignalEnabler Id` associated with a `Signal` .
Parameters	`osid.id.Id`	`signalId`	`Id` of the `Signal`
Return	`osid.id.IdList`		the signal enabler `Ids`
Errors	NOT_FOUND		`signalId` is not found
	NULL_ARGUMENT		`signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSignalEnablersForSignal
Description	Gets the `SignalEnabler` associated with a `Signal` .
Parameters	`osid.id.Id`	`signalId`	`Id` of the `Signal`
Return	`osid.mapping.path.rules.SignalEnablerList`		the signal enablers
Errors	NOT_FOUND		`signalId` is not found
	NULL_ARGUMENT		`signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSignalIdsForSignalEnabler
Description	Gets the `Signal` `Ids` mapped to a `SignalEnabler` .
Parameters	`osid.id.Id`	`signalEnablerId`	`Id` of a `SignalEnabler`
Return	`osid.id.IdList`		list of signal `Ids`
Errors	NOT_FOUND		`signalEnablerId` is not found
	NULL_ARGUMENT		`signalEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSignalsForSignalEnabler
Description	Gets the `Signals` mapped to a `SignalEnabler` .
Parameters	`osid.id.Id`	`signalEnablerId`	`Id` of a `SignalEnabler`
Return	`osid.mapping.path.SignalList`		list of signals
Errors	NOT_FOUND		`signalEnablerId` is not found
	NULL_ARGUMENT		`signalEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.