src.server
Class ModuleMeta

java.lang.Object
  src.server.ModuleMeta

public class ModuleMeta

extends java.lang.Object

Meta information structure for modules. This structure is used to hold all meta information about modules. This is information that doesn't directly effect the module but is more useful to the user of the module. Last updated $Date: 2005/08/09 21:00:21 $ by $Author: andreas $ Changelog: $Log: ModuleMeta.html,v $ Revision 1.1.1.1 2005/08/09 21:00:21 andreas Initial entry Revision 1.2 2005/05/04 13:35:41 andreas Implemented setting checks in the config. Revision 1.1 2005/05/04 11:24:48 linus Made updates to: - Configuration handlign - Query testing - Module handling (including module settings).

Version:

$Revision: 1.1.1.1 $ TODO

Author:

linus

Constructor Summary

ModuleMeta(java.lang.String moduleName, java.lang.String moduleDescription, java.lang.String moduleClassName)

Method Summary

void	addModuleHelp(java.lang.String helpName, java.lang.String helpText)
java.util.HashSet	getModuleAcceptedSettings() Gets the setting names that are accepted by the module.
java.lang.String	getModuleClassName()
java.lang.String	getModuleDescription()
java.util.HashMap	getModuleHelp()
java.lang.String	getModuleHelp(java.lang.String helpName)
java.lang.String	getModuleName()
void	setModuleAcceptedSettings(java.util.HashSet moduleAcceptedSettings) Sets the setting names that are accepted by the module.
void	setModuleClassName(java.lang.String moduleClassName)
void	setModuleDescription(java.lang.String moduleDescription)
void	setModuleHelp(java.util.HashMap moduleHelp)
void	setModuleName(java.lang.String moduleName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleMeta

public ModuleMeta(java.lang.String moduleName,
                  java.lang.String moduleDescription,
                  java.lang.String moduleClassName)

Parameters:

moduleName -

moduleClassName -

Method Detail

addModuleHelp

public void addModuleHelp(java.lang.String helpName,
                          java.lang.String helpText)

Parameters:

helpName - The name to add.

helpText - The text to associate with the name.

getModuleHelp

public java.lang.String getModuleHelp(java.lang.String helpName)

Parameters:

helpName - The name of the help string to get.

Returns:

The help string.

getModuleClassName

public java.lang.String getModuleClassName()

Returns:

Returns the moduleClassName.

setModuleClassName

public void setModuleClassName(java.lang.String moduleClassName)

Parameters:

moduleClassName - The moduleClassName to set.

getModuleName

public java.lang.String getModuleName()

Returns:

Returns the moduleName.

setModuleName

public void setModuleName(java.lang.String moduleName)

Parameters:

moduleName - The moduleName to set.

getModuleDescription

public java.lang.String getModuleDescription()

Returns:

Returns the moduleDescription.

setModuleDescription

public void setModuleDescription(java.lang.String moduleDescription)

Parameters:

moduleDescription - The moduleDescription to set.

getModuleHelp

public java.util.HashMap getModuleHelp()

Returns:

Returns the moduleHelp.

setModuleHelp

public void setModuleHelp(java.util.HashMap moduleHelp)

Parameters:

moduleHelp - The moduleHelp to set.

setModuleAcceptedSettings

public void setModuleAcceptedSettings(java.util.HashSet moduleAcceptedSettings)

Sets the setting names that are accepted by the module.

Parameters:

moduleAcceptedSettings - The set with the setting names.

getModuleAcceptedSettings

public java.util.HashSet getModuleAcceptedSettings()

Gets the setting names that are accepted by the module.