alma.acs.nc.sm.generated

Interface EventSubscriberSignalHandler

All Known Implementing Classes:

EventSubscriberSignalDispatcher, EventSubscriberStateMachine

public interface EventSubscriberSignalHandler

Interface to send events to the SM, similar to the IDL-generated component "Operations" interface

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

Author:

hsommer

Method Summary

Modifier and Type	Method and Description
boolean	cleanUpEnvironment()
boolean	fireSignal(EventSubscriberSignal signal)
boolean	fireSignalWithErrorFeedback(EventSubscriberSignal signal)
boolean	resume()
boolean	setUpEnvironment()
boolean	startReceivingEvents()
boolean	stopReceivingEvents()
boolean	suspend()

Method Detail

setUpEnvironment

boolean setUpEnvironment()
                  throws AcsJIllegalStateEventEx,
                         AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

startReceivingEvents

boolean startReceivingEvents()
                      throws AcsJIllegalStateEventEx,
                             AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

suspend

boolean suspend()
         throws AcsJIllegalStateEventEx,
                AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

resume

boolean resume()
        throws AcsJIllegalStateEventEx,
               AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

stopReceivingEvents

boolean stopReceivingEvents()
                     throws AcsJIllegalStateEventEx,
                            AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

cleanUpEnvironment

boolean cleanUpEnvironment()
                    throws AcsJIllegalStateEventEx,
                           AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx

fireSignal

boolean fireSignal(EventSubscriberSignal signal)

fireSignalWithErrorFeedback

boolean fireSignalWithErrorFeedback(EventSubscriberSignal signal)
                             throws AcsJIllegalStateEventEx,
                                    AcsJStateMachineActionEx

Throws:

AcsJIllegalStateEventEx

AcsJStateMachineActionEx