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

Interface	osid.mapping.path.rules.SignalEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session provides methods to apply `SignalEnablers` to `Signals` . A `Signal` with multiple `SignalEnablers` means any positive rule evaluation across the enablers result in an enabled `Signal` .
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	canAssignSignalEnablers
Description	Tests if this user can alter signal enabler/signal mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignSignalEnablerToSignal
Description	Adds an existing `SignalEnabler` to a `Signal` .
Parameters	`osid.id.Id`	`signalEnablerId`	the `Id` of the `SignalEnabler`
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal`
Errors	ALREADY_EXISTS		`signalEnablerId` is already applied to `signalId`
	NOT_FOUND		`signalEnablerId` or `signalId` not found
	NULL_ARGUMENT		`signalEnablerId` or `signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignSignalEnablerFromSignal
Description	Removes a `SignalEnabler` from a `Signal` .
Parameters	`osid.id.Id`	`signalEnablerId`	the `Id` of the `SignalEnabler`
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal`
Errors	NOT_FOUND		`signalEnablerId` or `signalId` not found or `signalEnablerId` not applied to `signalId`
	NULL_ARGUMENT		`signalEnablerId` or `signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceSignalEnablers
Description	Tests if this user can order `SignalEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `SignalEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveSignalEnablerAhead
Description	Reorders signal enablers for a signal by moving the specified signal enabler in front of a reference signal enabler.
Parameters	`osid.id.Id`	`signalEnablerId`	the `Id` of a `SignalEnabler`
	`osid.id.Id`	`signalId`	the `Id` of a `Signal`
	`osid.id.Id`	`referenceId`	the reference signal enabler `Id`
Errors	NOT_FOUND		`signalEnablerId, signalId` , or `referenceId` not found or, `signalEnablerId` or `referenceId` not related to `signalId`
	NULL_ARGUMENT		`signalEnablerId, signalId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveSignalEnablerBehind
Description	Reorders signal enablers for a signal by moving the specified signal enabler behind a reference signal enabler.
Parameters	`osid.id.Id`	`signalEnablerId`	the `Id` of a `SignalEnabler`
	`osid.id.Id`	`signalId`	the `Id` of a `Signal`
	`osid.id.Id`	`referenceId`	the reference signal enabler `Id`
Errors	NOT_FOUND		`signalEnablerId, signalId` , or `referenceId` not found or, `signalEnablerId` or `referenceId` not related to `signalId`
	NULL_ARGUMENT		`signalEnablerId, signalId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderSignalEnablers
Description	Reorders a set of signal enablers for a signal.
Parameters	`osid.id.Id[]`	`signalEnablerIds`	the `Ids` for a set of `SignalEnablers`
Parameters	`osid.id.Id`	`signalId`	the `Id` of a `Signal`
Errors	NOT_FOUND		`signalId` not found or, an `signalEnablerId` not related to `signalId`
	NULL_ARGUMENT		`signalEnabelrIds` or `signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.