EspressReport 6.6

quadbase.common.param
Interface Parameters


public interface Parameters

This is an interface that is used to manipulate parameters in a (report) template. To get an instance of this class use:

 
    QbReport r = ...;
    Parameters params = r.getAllParameters();
 
 

See Also:
Param, QbReport

Method Summary
 Param get(int index)
          Gets a particular Param by index.
 Parameters get(java.lang.String name)
          Gets a set of parameters by its name.
 Param get(java.lang.String parent, java.lang.String name, boolean isFormula)
          Gets a Param by its parent name and name.
 int size()
          the total number of parameters
 

Method Detail

size

int size()
the total number of parameters


get

Param get(int index)
Gets a particular Param by index.

Parameters:
index - 0 <= index < size()

get

Param get(java.lang.String parent,
          java.lang.String name,
          boolean isFormula)
Gets a Param by its parent name and name. Both must not be null.

Parameters:
parent - the name of the template that contains this parameter. This may either be the name of a report, or the name of a sub report, etc.
name - the name of the parameter

get

Parameters get(java.lang.String name)
Gets a set of parameters by its name. Note that this returns a set of parameters (Params) because parameter name does not have to be unique across templates (between main report and sub report, between two sub reports, etc.). Also, a formula parameter and a query parameter in the same template can have the same name.

Parameters:
name - the name of the parameter

EspressReport 6.6