Interface SignalEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SignalEnablerRuleApplicationSession
extends OsidSession

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 Summary

Modifier and Type	Method	Description
void	assignSignalEnablerToSignal(Id signalEnablerId, Id signalId)	Adds an existing SignalEnabler to a Signal .
boolean	canAssignSignalEnablers()	Tests if this user can alter signal enabler/signal mappings.
boolean	canSequenceSignalEnablers()	Tests if this user can order SignalEnablers .
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
void	moveSignalEnablerAhead(Id signalEnablerId, Id signalId, Id referenceId)	Reorders signal enablers for a signal by moving the specified signal enabler in front of a reference signal enabler.
void	moveSignalEnablerBehind(Id signalEnablerId, Id signalId, Id referenceId)	Reorders signal enablers for a signal by moving the specified signal enabler behind a reference signal enabler.
void	orderSignalEnablers(Id[] signalEnablerIds, Id signalId)	Reorders a set of signal enablers for a signal.
void	unassignSignalEnablerFromSignal(Id signalEnablerId, Id signalId)	Removes a SignalEnabler from a Signal .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
    throws OperationFailedException,
PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignSignalEnablers

boolean canAssignSignalEnablers()

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.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignSignalEnablerToSignal

void assignSignalEnablerToSignal(Id signalEnablerId,
 Id signalId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing SignalEnabler to a Signal .

Parameters:

signalEnablerId - the Id of the SignalEnabler

signalId - the Id of the Signal

Throws:

AlreadyExistsException - signalEnablerId is already applied to signalId

NotFoundException - signalEnablerId or signalId not found

NullArgumentException - signalEnablerId or signalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSignalEnablerFromSignal

void unassignSignalEnablerFromSignal(Id signalEnablerId,
 Id signalId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a SignalEnabler from a Signal .

Parameters:

signalEnablerId - the Id of the SignalEnabler

signalId - the Id of the Signal

Throws:

NotFoundException - signalEnablerId or signalId not found or signalEnablerId not applied to signalId

NullArgumentException - signalEnablerId or signalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceSignalEnablers

boolean canSequenceSignalEnablers()

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.

Returns:

false if SignalEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveSignalEnablerAhead

void moveSignalEnablerAhead(Id signalEnablerId,
 Id signalId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

signalEnablerId - the Id of a SignalEnabler

signalId - the Id of a Signal

referenceId - the reference signal enabler Id

Throws:

NotFoundException - signalEnablerId, signalId , or referenceId not found or, signalEnablerId or referenceId not related to signalId

NullArgumentException - signalEnablerId, signalId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveSignalEnablerBehind

void moveSignalEnablerBehind(Id signalEnablerId,
 Id signalId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

signalEnablerId - the Id of a SignalEnabler

signalId - the Id of a Signal

referenceId - the reference signal enabler Id

Throws:

NotFoundException - signalEnablerId, signalId , or referenceId not found or, signalEnablerId or referenceId not related to signalId

NullArgumentException - signalEnablerId, signalId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderSignalEnablers

void orderSignalEnablers(Id[] signalEnablerIds,
 Id signalId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of signal enablers for a signal.

Parameters:

signalEnablerIds - the Ids for a set of SignalEnablers

signalId - the Id of a Signal

Throws:

NotFoundException - signalId not found or, an signalEnablerId not related to signalId

NullArgumentException - signalEnabelrIds or signalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.