Report

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 Report

All Superinterfaces:: KentModule, com.dghda.module.Module

public interface Report
extends KentModule

The interface all reports must implement. A report's output consists of a report template and report data. The template contains layout and formatting information (which will not change between runs), while the data is the row and column information, which will tend to change between runs. Both the template and the data may be affected by altering report configuration settings. The template/data seperation is similar to that in the Kugar application (a part of the KOffice suite). The report template document structure is described in the file dtd/template.dtd.

Nested Class Summary

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

com.dghda.module.Module.ModuleVersion

Field Summary

Fields inherited from interface com.dghda.kent.KentModule

ACTION_ID, AUTHENTICATED_USER, FORMAT_ID, REPORT_ID

Method Summary

java.lang.String getReportData(java.util.Properties config)
Runs the report with the given configuration options.

java.lang.String getReportTemplate(java.util.Properties config)
Returns the report template with the given configuration options.

Methods inherited from interface com.dghda.kent.KentModule

getConfigurationOptions

Methods inherited from interface com.dghda.module.Module

getDescription, getID, getName, getVersion

Method Detail

getReportTemplate

public java.lang.String getReportTemplate(java.util.Properties config)
                                   throws ReportingException

Returns the report template with the given configuration options.

getReportData

public java.lang.String getReportData(java.util.Properties config)
                               throws ReportingException

Runs the report with the given configuration options. The XML returned will be processed in accordance with the report's template.