OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SignalEnablerRuleApplicationSession
Implementsosid.OsidSession
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.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignSignalEnablers
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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignSignalEnablerToSignal
Description

Adds an existing SignalEnabler to a Signal.

Parametersosid.id.IdsignalEnablerIdthe Id of the SignalEnabler
osid.id.IdsignalIdthe Id of the Signal
ErrorsALREADY_EXISTS signalEnablerId is already applied to signalId
NOT_FOUND signalEnablerId or signalId not found
NULL_ARGUMENT signalEnablerId or signalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSignalEnablerFromSignal
Description

Removes a SignalEnabler from a Signal.

Parametersosid.id.IdsignalEnablerIdthe Id of the SignalEnabler
osid.id.IdsignalIdthe Id of the Signal
ErrorsNOT_FOUND signalEnablerId or signalId not found or signalEnablerId not applied to signalId
NULL_ARGUMENT signalEnablerId or signalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceSignalEnablers
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.

Returnboolean false if SignalEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveSignalEnablerAhead
Description

Reorders signal enablers for a signal by moving the specified signal enabler in front of a reference signal enabler.

Parametersosid.id.IdsignalEnablerIdthe Id of a SignalEnabler
osid.id.IdsignalIdthe Id of a Signal
osid.id.IdreferenceIdthe reference signal enabler Id
ErrorsNOT_FOUND signalEnablerId, signalId, or referenceId not found or, signalEnablerId or referenceId not related to signalId
NULL_ARGUMENT signalEnablerId, signalId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveSignalEnablerBehind
Description

Reorders signal enablers for a signal by moving the specified signal enabler behind a reference signal enabler.

Parametersosid.id.IdsignalEnablerIdthe Id of a SignalEnabler
osid.id.IdsignalIdthe Id of a Signal
osid.id.IdreferenceIdthe reference signal enabler Id
ErrorsNOT_FOUND signalEnablerId, signalId, or referenceId not found or, signalEnablerId or referenceId not related to signalId
NULL_ARGUMENT signalEnablerId, signalId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderSignalEnablers
Description

Reorders a set of signal enablers for a signal.

Parametersosid.id.Id[]signalEnablerIdsthe Ids for a set of SignalEnablers
osid.id.IdsignalIdthe Id of a Signal
ErrorsNOT_FOUND signalId not found or, an signalEnablerId not related to signalId
NULL_ARGUMENT signalEnabelrIds or signalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.