Class actuate.parameter.ParameterValue
Description
ParameterValue is a container for the value of Parameter to pass to a report for processing. When a user sets a value in the interface, the corresponding ParameterValue must change.
Constructor
Syntax
actuate.parameter.ParameterValue( )
Constructs a new ParameterValue object.
Function summary
Table 11‑9 lists actuate.parameter.ParameterValue functions.
Table 11‑9 actuate.parameter.ParameterValue functions
Function | Description |
getColumnName( ) | Gets the name of the column in this ParameterValue |
getColumnType( ) | Gets the data type value of the column for this ParameterValue |
getDataType( ) | Gets the dataType value for this ParameterValue |
getName( ) | Gets the name value for this ParameterValue |
getValue( ) | Gets the value or values for this ParameterValue |
getValueIsNull( ) | Gets the valueIsNull value for this ParameterValue |
setValue( ) | Sets the value for this ParameterValue |
setValueIsNull( ) | Sets the valueIsNull value for this ParameterValue |
actuate.parameter.ParameterValue.getColumnName
Syntax
string ParameterValue.getColumnName( )
Gets the column name value for this ParameterValue. Columns are supported as part of ad hoc parameters.
Returns
String. The name of the column.
Example
To store the column name for the parameter value pvalue in a variable called columnname, use code similar to the following:
var columnname = pvalue.getColumnName( );
actuate.parameter.ParameterValue.getColumnType
Syntax
string ParameterValue.getColumnType( )
Gets the data type value of the column for this ParameterValue. Columns are supported as part of ad hoc parameters.
Returns
String. Possible values are null, "", "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
Example
To store the column type for the parameter value pvalue in a variable called columntype, use code similar to the following:
var columntype = pvalue.getColumnType( );
actuate.parameter.ParameterValue.getDataType
Syntax
string ParameterValue.getDataType( )
Gets the dataType value for this ParameterValue.
Returns
String. Possible values are null, "", "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
Example
To store the data type for the parameter value pvalue in a variable called type, use code similar to the following:
var type = pvalue.getDataType( );
actuate.parameter.ParameterValue.getName
Syntax
string ParameterValue.getName( )
Gets the name value for this ParameterValue.
Returns
String.
Example
To store the name of the parameter value pvalue in a variable called name, use code similar to the following:
var name = pvalue.getName( );
actuate.parameter.ParameterValue.getValue
Syntax
string[ ] ParameterValue.getValue( )
Gets the value values for this ParameterValue.
Returns
String or array of strings. The value or values of this ParameterValue object.
Example
To store the value of the parameter value pvalue in a variable called value, use code similar to the following:
var value = pvalue.getValue( );
actuate.parameter.ParameterValue.getValueIsNull
Syntax
boolean ParameterValue.getValueIsNull( )
Gets the valueIsNull value for this ParameterValue.
Returns
Boolean. True indicates that this ParameterValue is null.
Example
To alert the user that the value of the parameter value pvalue is null, use code similar to the following:
if (pavalue.getValueIsNull( )){
alert('Default value is null!');
}
actuate.parameter.ParameterValue.setValue
Syntax
void ParameterValue.setValue(string[ ] value)
Sets the value or values for this ParameterValue.
Parameter
value
String or array of strings. The value or values of this ParameterValue object.
Example
To set the value of the parameter value pvalue to 2010, use code similar to the following:
pvalue.setValue("2010");
To set the values of the ParameterValue object pvalues to 2008, 2009, and 2010, use code similar to the following:
pvalue.setValue({"2008", "2009", "2010"});
actuate.parameter.ParameterValue.setValueIsNull
Syntax
void ParameterValue.setValueIsNull(boolean valueIsNull)
Sets the valueIsNull value for this ParameterValue.
Parameter
valueIsNull
Boolean. True indicates that this ParameterValue is null.
Example
To set the value of parameter value pvalue to null, use code similar to the following:
pvalue.setValueIsNull(true);