Class actuate.parameter.ParameterValue

A container for the value of a Parameter to pass to a report for processing. When a user sets a value in the interface, the corresponding ParameterValue must change.

Because ParameterValue is much smaller that actuate.parameter.ParameterDefinition, it is the recommended means of communicating to the server that a parameter value has changed or passing a parameter value to a viewer element. Sending an entire ParameterDefinition has a larger effect on system performance.
Member of: actuate.parameter.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.parameter.ParameterValue() Constructs a container for the value of a Parameter to pass to a report for processing.

Method Summary
Method Attributes	Method Name and Description
	getColumnName() Gets the column name value for this ParameterValue.
	getColumnType() Gets the data type value of the column for this ParameterValue.
	getDataType() Gets the dataType value for this ParameterValue.
	getDisplayName() Gets the displayed name value for this ParameterValue.
	getGroup() Gets the group value for this ParameterValue.
	getName() Gets the name value for this ParameterValue.
	getPosition() Gets the position value for this ParameterValue.
	getPromptParameter() Gets the promptParameter value for this ParameterValue.
	getValue() Gets the value valuse for this ParameterValue.
	getValueIsNull() Gets the valueIsNull value for this ParameterValue.
	isViewParameter() Gets the isViewParameter value for this ParameterValue.
	setColumnName(columnName) Sets the column name value for this ParameterValue.
	setColumnType(columnType) Sets the data type of the column for this ParameterValue.
	setDataType(dataType) Sets the dataType value for this ParameterValue.
	setDisplayName(displayName) Sets the displayed name value for this ParameterValue.
	setGroup(group) Sets the group value for this ParameterValue.
	setIsViewParameter(isViewParameter) Sets the isViewParameter value for this ParameterValue.
	setName(name) Sets the name value for this ParameterValue.
	setPosition(position) Sets the position value for this ParameterValue.
	setPromptParameter(promptParameter) Sets the promptParameter value for this ParameterValue.
	setValue(value) Sets the value for this ParameterValue.
	setValueIsNull(valueIsNull) Sets the valueIsNull value for this ParameterValue.

Class Detail

actuate.parameter.ParameterValue()

Constructs a container for the value of a Parameter to pass to a report for processing.

Method Detail

{String} getColumnName()

Gets the column name value for this ParameterValue. Columns are supported as part of ad hoc parameters. 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( );

Returns:: {String} The name of the column.

{String} getColumnType()

Gets the data type value of the column for this ParameterValue. Columns are supported as part of ad hoc parameters. 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( );

Returns:: {String} columnType Possible values are null, "", "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

{String} getDataType()

Gets the dataType value for this ParameterValue. 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( );

Returns:: {String} dataType Possible values are null, "", "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

{String} getDisplayName()

Gets the displayed name value for this ParameterValue. To save the displayed name of the parameter value pvalue to a variable called displayedName, use code similar to the following:

	var displayedName = pvalue.getDisplayName( );

Returns:: {String} A displayed parameter name.

{String} getGroup()

Gets the group value for this ParameterValue. To store the group that the parameter value pvalue belongs to in a variable called group, use code similar to the following:

	var group = pvalue.getGroup( );

Returns:: {String} group

{String} getName()

Gets the name value for this ParameterValue. To store the name of the parameter value pvalue in a variable called name, use code similar to the following:

	var name = pvalue.getName( );

Returns:: {String} name

{Integer} getPosition()

Gets the position value for this ParameterValue. To save the position of the parameter value pvalue in the parameter list to a variable called pos, use code similar to the following:

	var pos = pvalue.getPosition( );

Returns:: {Integer} The position from the top of the parameter list.

{boolean} getPromptParameter()

Gets the promptParameter value for this ParameterValue. To store the prompt parameter of the parameter value pvalue in a variable called prompt, use code similar to the following:

	var prompt = pvalue.getPromptParameter( );

Returns:: {boolean} True indicates that this parameter prompts the user.

{String[ ]} getValue()

Gets the value valuse for this ParameterValue. To store the value of the parameter value pvalue in a variable called value, use code similar to the following:

	var value = pvalue.getValue( );

Returns:: {String[ ]} The value or values of this ParameterValue object.

{boolean} getValueIsNull()

Gets the valueIsNull value for this ParameterValue. 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!');
	}

Returns:: {boolean} True indicates that this ParameterValue is null.

{boolean} isViewParameter()

Gets the isViewParameter value for this ParameterValue. To set specific help text for the parameter value pvalue if it is a view-time parameter, use code similar to the following:

	if (pvalue.isViewParameter( )){
		pvalue.setHelpText("This is a view-time parameter.");
	}

Returns:: {boolean} isViewParameter. True indicates a view-time parameter.

{void} setColumnName(columnName)

Sets the column name value for this ParameterValue. To set the column name for the parameter value pvalue to Year, use code similar to the following:

	pvalue.setColumnName("Year");

Parameters:
{String} columnName: The name of the column.

Returns:: {void}

{void} setColumnType(columnType)

Sets the data type of the column for this ParameterValue. Used for queries. To set the column type for the parameter value pvalue to Date, use code similar to the following:

	pvalue.setColumnType("Date");

Parameters:
{String} columnType: Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Returns:: {void}

{void} setDataType(dataType)

Sets the dataType value for this ParameterValue. To set the data type for the parameter value pvalue to Date, use code similar to the following:

	pvalue.setDataType("Date");

Parameters:
{String} dataType: Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Returns:: {void}

{void} setDisplayName(displayName)

Sets the displayed name value for this ParameterValue. To set the display name of the parameter value pvalue to "Year," use code similar to the following:

	pvalue.setDisplayName("Year");

Parameters:
{String} displayName: A displayed parameter name.

Returns:: {void}

{void} setGroup(group)

Sets the group value for this ParameterValue. To set the group for the parameter value pvalue to Customer Details, use code similar to the following:

	pvalue.setGroup("Customer Details");

Parameters:
{String} group: The name of the group.

Returns:: {void}

{void} setIsViewParameter(isViewParameter)

Sets the isViewParameter value for this ParameterValue. To make the parameter value pvalue into a view-time parameter, use code similar to the following:

	pvalue.setIsViewParameter(true);

Parameters:
{boolean} isViewParameter: True indicates a view-time parameter.

Returns:: {void}

{void} setName(name)

Sets the name value for this ParameterValue. To set the name of the parameter value pvalue to "Year," use code similar to the following:

	pvalue.setName("Year");

Parameters:
{String} name: A parameter name.

Returns:: {void}

{void} setPosition(position)

Sets the position value for this ParameterValue. To move the parameter value pvalue one place farther down in the parameter list, use code similar to the following:

	pvalue.setPosition(++pvalue.getPosition( ));

Parameters:
{Integer} position: The position from the top of the parameter list.

Returns:: {void}

{void} setPromptParameter(promptParameter)

Sets the promptParameter value for this ParameterValue. To set the parameter value pvalue to not prompt the user, use code similar to the following:

	pvalue.setPromptParameter(false);

Parameters:
{boolean} promptParameter: True indicates that this parameter prompts the user.

Returns:: {void}

{void} setValue(value)

Sets the value for this ParameterValue. 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"});>/pre>

Parameters:
{Sting[ ]} value: The value or values of this ParameterValue object.

Returns:: {void}

{void} setValueIsNull(valueIsNull)

Sets the valueIsNull value for this ParameterValue. To set the value of parameter value pvalue to null, use code similar to the following:

	pvalue.setValueIsNull(true);

Parameters:
{boolean} valueIsNull: True indicates that this ParameterValue is null.

Returns:: {void}

Classes

Class actuate.parameter.ParameterValue