com.serotonin.m2m2.module
Class SystemSettingsDefinition

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

public abstract class SystemSettingsDefinition
extends ModuleElementDefinition

This class provides a means to insert a section into the system settings page. Use this if you need to store values in the system settings table that users are allowed to modify.

Author:

Matthew Lohbihler

Constructor Summary

SystemSettingsDefinition()

Method Summary

abstract java.lang.String	getDescriptionKey() The reference key to the description used as the section header.
abstract java.lang.String	getSectionJspPath() The module relative path to the JSP file that provides the user interface for editing the system settings.

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

SystemSettingsDefinition

public SystemSettingsDefinition()

Method Detail

getDescriptionKey

public abstract java.lang.String getDescriptionKey()

The reference key to the description used as the section header.

Returns:

the reference key

getSectionJspPath

public abstract java.lang.String getSectionJspPath()

The module relative path to the JSP file that provides the user interface for editing the system settings.

Returns:

the path