KentModule

Overview

Package

Class

Use

Deprecated

Index

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

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.dghda.kent
Interface KentModule

All Superinterfaces:: com.dghda.module.Module

All Known Subinterfaces:: Report, ReportAction, ReportTransform

All Known Implementing Classes:: BaseKentModule

public interface KentModule
extends com.dghda.module.Module

Kent modules have configurations and a way to resolve external XML entities.

Nested Class Summary

Nested classes inherited from class com.dghda.module.Module

com.dghda.module.Module.ModuleVersion

Field Summary

static java.lang.String ACTION_ID
          The name of the property containing the selected report actions.

static java.lang.String AUTHENTICATED_USER
          The configuration option that contains the authenticated use name, if any.

static java.lang.String FORMAT_ID
          The name of the property containing the selected report output format.

static java.lang.String REPORT_ID
          The name of the property containing the module name.

Method Summary

java.lang.String getConfigurationOptions(java.util.Properties config)
          Return an XML document describing the configuration options for the module.

Methods inherited from interface com.dghda.module.Module

getDescription, getID, getName, getVersion

Field Detail

REPORT_ID

public static final java.lang.String REPORT_ID

The name of the property containing the module name.

See Also:: Constant Field Values

FORMAT_ID

public static final java.lang.String FORMAT_ID

The name of the property containing the selected report output format.

See Also:: Constant Field Values

ACTION_ID

public static final java.lang.String ACTION_ID

The name of the property containing the selected report actions.

See Also:: Constant Field Values

AUTHENTICATED_USER

public static final java.lang.String AUTHENTICATED_USER

The configuration option that contains the authenticated use name, if any.

See Also:: Constant Field Values

Method Detail

getConfigurationOptions

public java.lang.String getConfigurationOptions(java.util.Properties config)

Return an XML document describing the configuration options for the module. Configuration options themselves may change depending on the current configuration. The XML should conform to the DTD contained in the file dtd/kentconfig.dtd.