alma.acs.nc.sm.generated

Class EventSubscriberSignalDispatcher

java.lang.Object

alma.acs.nc.sm.generated.EventSubscriberSignalDispatcher

All Implemented Interfaces:

EventSubscriberSignalHandler

Direct Known Subclasses:

EventSubscriberStateMachine

public abstract class EventSubscriberSignalDispatcher
extends java.lang.Object
implements EventSubscriberSignalHandler

Dispatches SM signals (events) by calling AcsScxmlEngine.fireSignalWithErrorFeedback(Enum) on the provided state machine.

This is a convenience class that can be used as a base class for the ACS component or other classes that use the state machine.

TODO: A code-generator option should decide whether the named event methods delegate to #fireSignal(Enum) or to #fireSignalWithErrorFeedback(Enum). Currently we use fireSignalWithErrorFeedback.

Author:

hsommer

Constructor Summary

Constructors

Constructor and Description
EventSubscriberSignalDispatcher()

Method Summary

Modifier and Type	Method and Description
boolean	cleanUpEnvironment()
boolean	fireSignal(EventSubscriberSignal signal)
boolean	fireSignalWithErrorFeedback(EventSubscriberSignal signal)
protected abstract AcsScxmlEngine<EventSubscriberSignal,EventSubscriberAction>	getScxmlEngine()
boolean	resume()
boolean	setUpEnvironment()
boolean	startReceivingEvents()
boolean	stopReceivingEvents()
boolean	suspend()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventSubscriberSignalDispatcher

public EventSubscriberSignalDispatcher()

Method Detail

getScxmlEngine

protected abstract AcsScxmlEngine<EventSubscriberSignal,EventSubscriberAction> getScxmlEngine()

setUpEnvironment

public boolean setUpEnvironment()
                         throws AcsJIllegalStateEventEx,
                                AcsJStateMachineActionEx

Specified by:

setUpEnvironment in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

startReceivingEvents

public boolean startReceivingEvents()
                             throws AcsJIllegalStateEventEx,
                                    AcsJStateMachineActionEx

Specified by:

startReceivingEvents in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

suspend

public boolean suspend()
                throws AcsJIllegalStateEventEx,
                       AcsJStateMachineActionEx

Specified by:

suspend in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

resume

public boolean resume()
               throws AcsJIllegalStateEventEx,
                      AcsJStateMachineActionEx

Specified by:

resume in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

stopReceivingEvents

public boolean stopReceivingEvents()
                            throws AcsJIllegalStateEventEx,
                                   AcsJStateMachineActionEx

Specified by:

stopReceivingEvents in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

cleanUpEnvironment

public boolean cleanUpEnvironment()
                           throws AcsJIllegalStateEventEx,
                                  AcsJStateMachineActionEx

Specified by:

cleanUpEnvironment in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

fireSignal

public boolean fireSignal(EventSubscriberSignal signal)

Specified by:

fireSignal in interface EventSubscriberSignalHandler

fireSignalWithErrorFeedback

public boolean fireSignalWithErrorFeedback(EventSubscriberSignal signal)
                                    throws AcsJIllegalStateEventEx,
                                           AcsJStateMachineActionEx

Specified by:

fireSignalWithErrorFeedback in interface EventSubscriberSignalHandler

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx