getParameterDetails

getParameterDetails(parameterName:     String;
                    type:              String output;
                    length:            Integer output;
                    scaleFactor:       Integer output;
                    value:             Any output;
                    ignoreInSelection: Boolean output;
                    isUsedInReport:    Boolean output);

The getParameterDetails method of the JadeReportWriterReport class obtains the following information for the parameter specified in the parameterName field.

Parameter	Returns…
type	Type
length	Length
scaleFactor	Scale factor
value	Current value
ignoreInSelection	When set to true (by using the setParameterIgnoreInSelection method), any selection criteria using the value specified in the parameterName parameter is dropped from the query (by generating true for the selection itself within the rest of the selection criteria)
isUsedInReport	True if used anywhere in the report, otherwise false

Use this method to write reports that have multiple selection criteria (for example, company, department, cost center, and so on) that are compared with specified parameter values and to run these reports with one or more of the selections being an ALL action (for example, a specific department but all cost centers). You can use the ignoreInSelection parameter so that you do not have to define a specific value as all for each primitive type. Bracketing and negation are unchanged for the selection overall.

If you use two or more parameters in a single selection (for example, is between or is one of), you must set the ignoreInSelection parameter for each of the parameters that are used for it to take effect. If not, the values of these parameters are used.

As the JADE Report Writer Designer application print and extract dialogs do not ask for values for parameters that are defined but not actually used anywhere, the isUsedInReport parameter provides that functionality. The parameter values are set when the report is designed by using the appropriate controls in the JADE Report Writer Designer application Report Properties dialog and by the JadeReportWriterReport class setParameterIgnoreInSelection method.