com.rshtech.util
Interface ModuleInformation

All Known Implementing Classes:

BasicModuleInformation

public interface ModuleInformation

An interface for retrieving information about a given module. Module information is data like its name, its version, etc. The interface supports module-specific customizations through the getInformation() method (which returns a Properties object of all the information currently known about the module).

Version:

$Revision: 3127 $

Author:

$Author: kostya $

Method Summary

java.lang.String	getDescription() Return the description of the module.
java.lang.String	getId() Return the id string for this module.
java.util.Properties	getInformation() Return all the information for this module.
java.lang.String	getName() Return the name for the module.
java.lang.String	getProperty(java.lang.String propertyName) Return the specified property (empty string if it does not exist).
java.lang.String	getVersion() Return the version string for the module.

Method Detail

getId

java.lang.String getId()

Return the id string for this module. The id is used to uniquely identify the module within the system.

Returns:

the id string for the module.

getName

java.lang.String getName()

Return the name for the module. This is a descriptive string useful for output and identification.

Returns:

the name value.

getDescription

java.lang.String getDescription()

Return the description of the module. This should be a short but descriptive string that describes the module and its purpose.

Returns:

the description of the module.

getVersion

java.lang.String getVersion()

Return the version string for the module. The version string will match a pattern of N.N.N-N (where N is a number) or any shorter version of that pattern.

Returns:

the version string.

getProperty

java.lang.String getProperty(java.lang.String propertyName)

Return the specified property (empty string if it does not exist).

Parameters:

propertyName - the name of the property to retrieve the value for.

Returns:

the specified property value (empty string if it does not exist).

getInformation

java.util.Properties getInformation()

Return all the information for this module. This will include the id, name, description, and version values plus anymore defined in the module information file (for future expansion and flexibility).

Returns:

the module information in Properties form.