com.serotonin.m2m2.module
Class AuditEventTypeDefinition

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

public abstract class AuditEventTypeDefinition
extends ModuleElementDefinition

Used for creating custom audit event types.

Constructor Summary

AuditEventTypeDefinition()

Method Summary

abstract java.lang.String	getDescriptionKey() A reference to a human readable and translatable name of the audit event type.
abstract java.lang.String	getEventListLink(int ref1, int ref2, com.serotonin.m2m2.i18n.Translations translations) This method provides an opportunity for the client code to return HTML code that will be used verbatim in the events list snippet.
abstract java.lang.String	getTypeName() The type name of the audit event.

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

AuditEventTypeDefinition

public AuditEventTypeDefinition()

Method Detail

getTypeName

public abstract java.lang.String getTypeName()

The type name of the audit event. Must be unique within the instance, and should be less than 30 characters.

getDescriptionKey

public abstract java.lang.String getDescriptionKey()

A reference to a human readable and translatable name of the audit event type. Key reference values in i18n.properties files.

Returns:

the reference key to the audit event short description.

getEventListLink

public abstract java.lang.String getEventListLink(int ref1,
                                                  int ref2,
                                                  com.serotonin.m2m2.i18n.Translations translations)

This method provides an opportunity for the client code to return HTML code that will be used verbatim in the events list snippet.

Parameters:

ref1 - the first reference id of the event

ref2 - the second reference id of the event

translations - the translations object with which to translate translatable messages

Returns:

the link, or null if none is to be displayed.