com.serotonin.m2m2.module
Class EventManagerListenerDefinition

java.lang.Object
  com.serotonin.m2m2.module.ModuleElementDefinition
      com.serotonin.m2m2.module.EventManagerListenerDefinition

public abstract class EventManagerListenerDefinition
extends ModuleElementDefinition

Provides a hook for modules to "listen" for things that happen in the event manager.

Author:

Matthew Lohbihler

Constructor Summary

EventManagerListenerDefinition()

Method Summary

abstract com.serotonin.m2m2.i18n.TranslatableMessage

autoAckEventWithMessage(com.serotonin.m2m2.rt.event.type.EventType eventType) Provides both notification of a new event, and the opportunity to automatically acknowledge it.

Methods inherited from class com.serotonin.m2m2.module.ModuleElementDefinition

getModule, initialize, uninstall

Methods inherited from class java.lang.Object

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

Constructor Detail

EventManagerListenerDefinition

public EventManagerListenerDefinition()

Method Detail

autoAckEventWithMessage

public abstract com.serotonin.m2m2.i18n.TranslatableMessage autoAckEventWithMessage(com.serotonin.m2m2.rt.event.type.EventType eventType)

Provides both notification of a new event, and the opportunity to automatically acknowledge it.

Parameters:

eventType - the type of event being raised.

Returns:

the message with which to acknowledge the event, or null if it should not be acknowledged.