Class actuate.xtabanalyzer.ParameterValue Description A container for the ParameterValue in the xtabanalyzer. Constructor Syntax actuate.xtabanalyzer.ParameterValue(string name, string value, boolean valueIsNull) The ParameterValue class is used to specify a cross tab ParameterValue object. Parameters name String. The parameter name. value String. The parameter value. valueIsNull Boolean. Whether the value is null. Function summary Table 5-17 lists actuate.xtabanalyzer.ParameterValue functions. Table 5-17 actuate.xtabanalyzer.ParameterValue functions Function Description getName( ) Returns the parameter name getValue( ) Returns the parameter value getValueIsNull( ) Returns whether the parameter has a null value setName( ) Sets the parameter name setEnabled( ) Sets the parameter value setMeasureIndex( ) Sets whether the parameter has a null value actuate.xtabanalyzer.ParameterValue.getName Syntax string ParameterValue.getName( ) Returns the name for the parameter. Returns String. The parameter name. Example This example retrieves the parameter name: function getParameterName(parametervalue){ if (parametervalue){ return parametervalue.getName( ); } return null; } actuate.xtabanalyzer.ParameterValue.getValue Syntax String[ ] Dimension.getValue( ) Returns the name for the ParameterValue. Returns String or array of strings. The parameter value or values. Example This example retrieves the parameter value: function getParameterValue(parametervalue){ if (parametervalue){ return parametervalue.getValue( ); } return null; } actuate.xtabanalyzer.ParameterValue.getValueIsNull Syntax boolean ParameterValue.getValueIsNull( ) Returns whether the parameter value is null. Returns Boolean. True indicates the parameter value is null. Example This example switches whether the parameter value is null: if (parametervalue){ if (parametervalue.getValueIsNull){ parametervalue.setValueIsNull(false); } else { parametervalue.setValueIsNull(true); } } actuate.xtabanalyzer.ParameterValue.setName Syntax void ParameterValue.setName(string name) Sets the parameter name. Parameters name String. The parameter name. Example This example sets the parameter name: function setParameterName(parametervalue, name){ parametervalue.setName(name); } actuate.xtabanalyzer.ParameterValue.setValue Syntax void ParameterValue.setValue(string[ ] value) Sets the parameter value. Parameters value String. The parameter value. Example This example sets the parameter value: function setParameterValue(parametervalue, value){ parametervalue.setValue(value); } actuate.xtabanalyzer.ParameterValue.setValueIsNull Syntax void ParameterValue.setValueIsNull(boolean valueIsNull) Sets the valueIsNull for the ParameterValue. Parameters valueIsNull Boolean. True switches the value to null. False disables the null value setting. Example This example switches whether the parameter value is null: if (parametervalue){ if (parametervalue.getValueIsNull){ parametervalue.setValueIsNull(false); } else { parametervalue.setValueIsNull(true); } }
