ParamNameValue

The ParamNameValue data type describes parameters defined for a reports and templates in Publisher.

The ParamNameValue data type is used in the ArrayOfParamNameValue, which is included in the ReportRequest, ReportDefinition, and JobInfo data types. ParamNameValue is also returned by the getTemplateParameters() Method and getReportParameters() Method.

Fields Provided by ParamNameValue

Field Description

String UIType

The type of parameter as defined in the Publisher data model user interface.

Valid values include:

  • Date

  • Hidden

  • Menu

  • Search

  • Text

String dataType

Valid values include:

  • Boolean

  • Date

  • Float

  • Integer

  • String

String dateFormatString

If UIType is "Date", this specifies the Date Format String. The date format string must be a Java date format (for example, MM-DD-YYYY).

String dateFrom

If UIType is "Date", this specifies the begin value of the date.

String dateTo

If UIType is "Date", this specifies the end value of the date.

String defaultValue

Specifies the default value of the parameter.

String fieldSize

For parameter types "Text" and "Date", specifies the text field size for the parameter.

String label

For all parameter types except "Hidden", specifies the display label for the parameter.

ArrayOfString lovLabels

If the parameter type is "Menu", specifies the values displayed in the list of values to the user.

boolean multiValuesAllowed

True indicates that a parameter may contain multiple values.

String name

The parameter name.

boolean refreshParamOnChange

For parameter types "Text" and "Menu", a value of true for this parameter indicates that other defined parameters should be refreshed when a selection is made for this parameter.

boolean selectAll

For parameter type "Menu", a value of true indicates that all values can be selected for the LOV.

boolean templateParam

A value of true indicates the parameter is defined in the RTF template.

boolean useNullForAll

For parameter type "Menu", a value of true indicates that a null will be passed if all values are selected for the parameter.

ArrayOfString values

See ArrayOfString.