org.pentaho.reporting.engine.classic.core.parameters
Interface ReportParameterDefinition

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

ModifiableReportParameterDefinition

All Known Implementing Classes:

DefaultParameterDefinition

public interface ReportParameterDefinition
extends Serializable, Cloneable

The ReportParameterDefinition provides user-supplied meta-data about the contents of the report-properties. It contains all information to automatically generated a parameter-page for these parameters and contains a reference to code that can validate the parameters.

The reporting engine itself will never generate parameter-pages, but the engine can validate parameters to prevent incomplete or ill-defined reports.

Author:

Thomas Morgner

Method Summary

Object	clone()
int	getParameterCount()
ParameterDefinitionEntry	getParameterDefinition(int parameter)
ParameterDefinitionEntry[]	getParameterDefinitions()
ReportParameterValidator	getValidator()

Method Detail

clone

Object clone()
             throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getParameterCount

int getParameterCount()

getParameterDefinitions

ParameterDefinitionEntry[] getParameterDefinitions()

getParameterDefinition

ParameterDefinitionEntry getParameterDefinition(int parameter)

getValidator

ReportParameterValidator getValidator()