Module

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> dghda >> [ module overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.dghda.module
Interface Module

All Known Implementing Classes:: BaseModule

public interface Module

A loadable module. The module's version information is implicitly included in the configuration settings. The property names containing the settings are given in the ModuleVersion class.

Nested Class Summary

static class Module.ModuleVersion
          A class which encapsulates a module's version information.

Method Summary

java.lang.String getDescription()
          Returns a description of the module.

java.lang.String getID()
          Returns the ID of the module.

java.lang.String getName()
          Returns the name of the module.

Module.ModuleVersion getVersion()
          Returns version information about the module.

Method Detail

getID

public java.lang.String getID()

Returns the ID of the module. This ID should be globally unique.

getName

public java.lang.String getName()

Returns the name of the module. This name should be suitable for display.

getVersion

public Module.ModuleVersion getVersion()

Returns version information about the module.

getDescription

public java.lang.String getDescription()

Returns a description of the module.