Classes


Class actuate.parameter.ParameterDefinition

Contains all of the qualities, values, names, and conditions for a parameter. A ParameterDefinition object can display options to the user and respond to user-generated events. The actuate.Parameter class downloads an array of ParameterDefinition objects with actuate.Parameter#downloadParameters. The order of this array is also the order in which the parameters are displayed. Parameters can be grouped to divide the parameters on the page into logical sets under a heading.

This class requires significant memory and bandwidth resources. ParameterValue is much smaller than ParameterDefinition. actuate.parameter.ParameterValue is the more efficient way to communicate to the server that a parameter value has changed.
Member of: actuate.parameter.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs an object containing all of the qualities, values, names, and conditions for a parameter.
Method Summary
Method Attributes Method Name and Description
 
Gets the autosuggest threshold value for this ParameterDefinition.
 
Gets the cascadingParentName value for this ParameterDefinition.
 
Gets the columnName value for this ParameterDefinition.
 
Gets the columnType value for this ParameterDefinition.
 
Gets the controlType value for this ParameterDefinition.
 
Gets the current display name for this ParameterDefinition.
 
Gets the dataType value for this ParameterDefinition.
 
Gets the defaultValue value for this ParameterDefinition, if applicable.
 
Returns true when the parameter's default value is null.
 
Gets the displayName value for this ParameterDefinition.
 
Gets the group for this ParameterDefinition, indicating if it is a member of a group.
 
Gets the groupPromptText value for this ParameterDefinition.
 
Gets the helpText for this ParameterDefinition.
 
Gets the name value for this ParameterDefinition.
 
Gets the operator list for this ParameterDefinition.
 
Gets the position in the Parameter array for this ParameterDefinition.
 
Gets the selectNameValueList for this ParameterDefinition.
 
Gets the selectValueList for this ParameterDefinition.
 
Gets the startExpanded value for this ParameterDefinition.
 
Gets the isAdHoc value for this ParameterDefinition.
 
Gets the isHidden value for this ParameterDefinition.
 
Gets the isPassword value for this ParameterDefinition.
 
Gets the isRequired value for this ParameterDefinition.
 
Gets the isViewParameter value for this ParameterDefinition.
 
Sets the autosuggest threshold for this ParameterDefinition.
 
setCascadingParentName(cascadingParentName)
Sets the cascadingParentName for this ParameterDefinition.
 
setColumnName(columnName)
Sets the columnName for this ParameterDefinition.
 
setColumnType(columnType)
Sets the columnType for this ParameterDefinition.
 
setControlType(controlType)
Sets the control type of this ParameterDefinition.
 
setCurrentDisplayName(currentDisplayName)
Sets the displayed name for this parameter.
 
setDataType(dataType)
Sets the dataType value for this ParameterDefinition.
 
setDefaultValue(defaultValue)
Sets the default value for this ParameterDefinition.
 
When true, sets the default value for this ParameterDefinition to null.
 
setDisplayName(displayName)
Sets the name to display on the parameter page for this ParameterDefinition.
 
setGroup(group)
Sets the group value for this ParameterDefinition.
 
setGroupPromptText(groupPromptText)
Sets the groupPromptText value for this ParameterDefinition.
 
setHelpText(helpText)
Sets the helpText value for this ParameterDefinition.
 
setIsAdHoc(isAdHoc)
Sets this parameter as an ad hoc parameter.
 
setIsHidden(isHidden)
Sets the parameter to hidden.
 
setIsPassword(isPassword)
Sets this parameter to treat its value as a password, which hides the input on the page and encrypts the value.
 
setIsRequired(isRequired)
Sets the parameter to required.
 
setIsViewParameter(isViewParameter)
Sets the isViewParameter value for this ParameterDefinition.
 
setName(name)
Sets the name to use internally for this ParameterDefinition.
 
setPosition(position)
Sets the position value for this ParameterDefinition.
 
setSelectNameValueList(selectNameValueList)
Sets the selectNameValueList value for this ParameterDefinition.
 
setSelectValueList(selectValueList)
Sets the selectValueList value for this ParameterDefinition.
 
setStartExpanded(startExpanded)
Sets the startExpanded value for this ParameterDefinition.
Class Detail
actuate.parameter.ParameterDefinition()
Constructs an object containing all of the qualities, values, names, and conditions for a parameter.
Method Detail
{Integer} getAutoSuggestThreshold()
Gets the autosuggest threshold value for this ParameterDefinition. The autosuggest threshold determines the number of characters a user types in before they are given suggestions from autosuggest. To store the autosuggest threshold of the parameter definition paramdef in a variable called threshold, use code similar to the following:
	var threshold = paramdef.getAutoSuggestThreshold( );
Returns:
{Integer} threshold

{String} getCascadingParentName()
Gets the cascadingParentName value for this ParameterDefinition. A cascading parent parameter is only used when one parameter depends upon another. To store the cascading parent name of the parameter definition paramdef in a variable called parentname, use code similar to the following:
	var parentname = paramdef.getCascadingParentName( );
Returns:
{String} The name of the parent parameter for any member of a cascading parameter set.

{String} getColumnName()
Gets the columnName value for this ParameterDefinition. This setting sets the column to retrieve data from for an ad hoc parameter that performs a query. To store the column name of the parameter definition paramdef in a variable called columnname, use code similar to the following:
	var columnname = paramdef.getColumnName( );
Returns:
{String} columnName

{String} getColumnType()
Gets the columnType value for this ParameterDefinition. This setting sets the data type queried by an ad hoc parameter that performs a query. To store the column type of the parameter definition paramdef in a variable called columntype, use code similar to the following:
	var columntype = paramdef.getColumnType( );
Returns:
{String} Possible values are: null, "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

{String} getControlType()
Gets the controlType value for this ParameterDefinition. It determines the form element displayed for the user to set the parameter value. To store the control type string for the parameter definition paramdef in a variable called controltype, use code similar to the following:
	var controltype = paramdef.getControlType( );
Returns:
{String} Possible values are: null, "", "ControlRadioButton", "ControlList", "ControlListAllowNew", and "ControlCheckBox".

{String} getCurrentDisplayName()
Gets the current display name for this ParameterDefinition. To store the current display name of the parameter definition paramdef in a variable called displayname, use code similar to the following:
	var displayname = paramdef.getDisplayName( );
Returns:
{String} The current display name.

{String} getDataType()
Gets the dataType value for this ParameterDefinition. To store the data type of the parameter definition paramdef in a variable called type, use code similar to the following:
	var type = paramdef.getDataType( );
Returns:
{String} Possible values are: "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

{String} getDefaultValue()
Gets the defaultValue value for this ParameterDefinition, if applicable. To store the default value as a string for the parameter definition paramdef in a variable called default, use code similar to the following:
	var default = paramdef.getDefaultValue( );
Returns:
{String} The default value.

{boolean} getDefaultValueIsNull()
Returns true when the parameter's default value is null. To alert the user that the default value is null for the parameter definition paramdef, use code similar to the following:
	if (paramdef.getDefaultValueIsNull( )){
		alert('Default value is null!');
	}
Returns:
{boolean}

{String} getDisplayName()
Gets the displayName value for this ParameterDefinition. To store the displayed name for the parameter definition paramdef in a variable called displayname, use code similar to the following:
	var displayname = paramdef.getDisplayName( );
Returns:
{String} The display name.

{String} getGroup()
Gets the group for this ParameterDefinition, indicating if it is a member of a group. To print the group name for the parameter definition paramdef to the current document, use code similar to the following:
	document.write(paramdef.getGroup( ));
Returns:
{String} A group name, or null if there is no group.

{String} getGroupPromptText()
Gets the groupPromptText value for this ParameterDefinition.
Returns:
{String} groupPromptText

{String} getHelpText()
Gets the helpText for this ParameterDefinition. To store the help text for the parameter definition paramdef in a variable called helptext, use code similar to the following:
	var helptext = paramdef.getHelpText( );
Returns:
{String} The help text.

{String} getName()
Gets the name value for this ParameterDefinition. To store the name for the parameter definition paramdef in a variable called paramname, use code similar to the following:
	var paramname = paramdef.getName( );
Returns:
{String} The parameter name.

{String[ ]} getOperatorList()
Gets the operator list for this ParameterDefinition. To store the list of operators for the parameter definition paramdef in a variable called ops, use code similar to the following:
	var ops = new Array( );
	ops = paramdef.getOperatorList( );
Returns:
{String[ ]} An array of Strings containing the operator list.

{Integer} getPosition()
Gets the position in the Parameter array for this ParameterDefinition. To store the position of the parameter definition paramdef in a variable called position, use code similar to the following:
	var position = paramdef.getPosition( );
Returns:
{Integer} position

{Array} getSelectNameValueList()
Gets the selectNameValueList for this ParameterDefinition. This list applies if the parameter is set with a selection list. To retrieve the name-value pair list for the parameter definition paramdef and put it into a new array, use code similar to the following:
	var namevalues = new array( );
	namevalues = paramdef.getSelectNameValueList( ).slice( );
Returns:
{Array} Array of actuate.parameter.NameValuePair objects.
See:
actuate.parameter.NameValuePair

{String[ ]} getSelectValueList()
Gets the selectValueList for this ParameterDefinition. To retrieve the list of values selectable for the parameter definition paramdef and put it into a new array, use code similar to the following:
	var selectvalues = new array( );
	selectvalues = paramdef.getSelectValueList( ).slice( );
Returns:
{String[ ]} An array of strings containing the select value list.

{boolean} getStartExpanded()
Gets the startExpanded value for this ParameterDefinition.
Returns:
{boolean} startExpanded

{boolean} isAdHoc()
Gets the isAdHoc value for this ParameterDefinition. To set the default value to null for the parameter definition paramdef if it is an ad hoc parameter, use code similar to the following:
	if (paramdef.isAdHoc( )){
		paramdef.setDefaultValueIsNull(true);
	}
Returns:
{boolean} True indicates that this parameter is an ad hoc parameter.

{boolean} isHidden()
Gets the isHidden value for this ParameterDefinition. To reveal a parameter with the parameter definition paramdef if it is hidden, use code similar to the following:
	if (paramdef.isHidden( )){
		paramdef.setIsHidden(false);
	}
Returns:
{boolean} True indicates that this parameter is hidden.

{boolean} isPassword()
Gets the isPassword value for this ParameterDefinition. To set the parameter definition paramdef as required if it is a password parameter, use code similar to the following:
	if (paramdef.isPassword( )){
		paramdef.setIsRequired(true);
	}
Returns:
{boolean} True indicates that the parameter is a password.

{boolean} isRequired()
Gets the isRequired value for this ParameterDefinition. To set specific help text for the parameter definition paramdef if it is a required parameter, use code similar to the following:
	if (paramdef.isRequired( )){
		paramdef.setHelpText("This parameter is required.");
	}
Returns:
{boolean} isRequired

{boolean} isViewParameter()
Gets the isViewParameter value for this ParameterDefinition. To set specific help text for the parameter definition paramdef if it is a view-time parameter, use code similar to the following:
	if (paramdef.isViewParameter( )){
		paramdef.setHelpText("This is a view-time parameter.");
	}
Returns:
{boolean} True indicates that the parameter is a view-time parameter. False indicates that the parameter is a run-time parameter.

{void} setAutoSuggestThreshold(threshold)
Sets the autosuggest threshold for this ParameterDefinition. The autosuggest threshold determines the number of characters a user types in before they are given suggestions from autosuggest. To always show the autosuggest dialog for the parameter definition paramdef, use code similar to the following:
	paramdef.setAutoSuggestThreshold(0);
Parameters:
{Integer} threshold
Returns:
{void}

{void} setCascadingParentName(cascadingParentName)
Sets the cascadingParentName for this ParameterDefinition. This sets another parameter as this parameter's parent. To set the parent name of the parameter definition paramdef to "Clark", use code similar to the following:
	paramdef.setCascadingParentName("Clark");
Parameters:
{String} cascadingParentName
Returns:
{void}

{void} setColumnName(columnName)
Sets the columnName for this ParameterDefinition. Used for queries. To set the parameter definition paramdef to access the ProductName column, use code similar to the following:
	paramdef.setColumnName("ProductName");
Parameters:
{string} columnName
Returns:
{void}

{void} setColumnType(columnType)
Sets the columnType for this ParameterDefinition. Used for queries. To allow the parameter definition paramdef to interpret a column as untyped data, use code similar to the following:
	paramdef.setColumnType("Unknown");
Parameters:
{String} columnType
Possible values are null, "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
Returns:
{void}

{void} setControlType(controlType)
Sets the control type of this ParameterDefinition. To set the parameter definition paramdef to use a control list, use code similar to the following:
	paramdef.setControlType("ControlList");
Parameters:
{String} controlType
Possible values are null, "", "AutoSuggest", "ControlRadioButton", "ControlList", "ControlListAllowNew", and "ControlCheckBox".
Returns:
{void}

{void} setCurrentDisplayName(currentDisplayName)
Sets the displayed name for this parameter. To set the display name for the parameter definition paramdef to "Year", use code similar to the following:
	paramdef.setCurrentDisplayName("Year");
Parameters:
{String} currentDisplayName
Returns:
{void}

{void} setDataType(dataType)
Sets the dataType value for this ParameterDefinition. To set the parameter definition paramdef data type to date, use code similar to the following:
	paramdef.setDataType("Date");
Parameters:
{String} dataType
Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
Returns:
{void}

{void} setDefaultValue(defaultValue)
Sets the default value for this ParameterDefinition. To set the default value of parameter definition paramdef to "2010", use code similar to the following:
	paramdef.setDefaultValue("2010");
Parameters:
{String} defaultValue
Returns:
{void}

{void} setDefaultValueIsNull(value)
When true, sets the default value for this ParameterDefinition to null. Sets the default value to no value in all other cases. To set the default value of parameter definition paramdef to null, use code similar to the following:
	paramdef.setDefaultValueIsNull(true);
Parameters:
{boolean} value
Returns:
{void}

{void} setDisplayName(displayName)
Sets the name to display on the parameter page for this ParameterDefinition. To set the displayed name of parameter definition paramdef to "Year", use code similar to the following:
	paramdef.setDisplayName("Year");
Parameters:
{String} displayName
Returns:
{void}

{void} setGroup(group)
Sets the group value for this ParameterDefinition. To assign the parameter definition paramdef to the "Customer Details" parameter group, use code similar to the following:
	paramdef.setGroup("Customer Details");
Parameters:
{String} group
Returns:
{void}

{void} setGroupPromptText(groupPromptText)
Sets the groupPromptText value for this ParameterDefinition.
Parameters:
{string} groupPromptText
Returns:
{void}

{void} setHelpText(helpText)
Sets the helpText value for this ParameterDefinition. To set specific help text for the parameter definition paramdef if it is a required parameter, use code similar to the following:
	if (paramdef.isRequired( )){
		paramdef.setHelpText("This parameter is required.")
	}
Parameters:
{String} helpText
Returns:
{void}

{void} setIsAdHoc(isAdHoc)
Sets this parameter as an ad hoc parameter. To enable the parameter definition paramdef to accept an ad hoc value, use code similar to the following:
	paramdef.setIsAdHoc(true);
Parameters:
{boolean} isAdHoc
True sets this parameter to ad hoc.
Returns:
{void}

{void} setIsHidden(isHidden)
Sets the parameter to hidden. To enable the parameter definition paramdef to accept an ad hoc value, use code similar to the following:
	paramdef.setIsAdHoc(true);
Parameters:
{boolean} isHidden
True hides the parameter.
Returns:
{void}

{void} setIsPassword(isPassword)
Sets this parameter to treat its value as a password, which hides the input on the page and encrypts the value. To set the parameter type accepted by the parameter definition paramdef to password, use code similar to the following:
	paramdef.setIsPassword(true);
Parameters:
{boolean} isPassword
True indicates a password value.
Returns:
{void}

{void} setIsRequired(isRequired)
Sets the parameter to required. To make the parameter defined by the parameter definition paramdef mandatory, use code similar to the following:
	paramdef.setIsRequired(true);
Parameters:
{boolean} isRequired
True indicates a mandatory parameter.
Returns:
{void}

{void} setIsViewParameter(isViewParameter)
Sets the isViewParameter value for this ParameterDefinition. To make the parameter defined by the parameter definition paramdef a view-time parameter, use code similar to the following:
	paramdef.setIsViewParameter(true);
Parameters:
{boolean} isViewParameter
Returns:
{void}

{void} setName(name)
Sets the name to use internally for this ParameterDefinition. To set the internal name of the parameter definition paramdef to Year, use code similar to the following:
	paramdef.setName("Year");
Parameters:
{String} name
Returns:
{void}

{void} setPosition(position)
Sets the position value for this ParameterDefinition. The index indicates the position in the array of the ParameterDefinition. To shift the parameter definition paramdef down on position in the parameter array, use code similar to the following:
	paramdef.setPosition(++paramdef.getPosition( ));
Parameters:
{Integer} position
Returns:
{void}

{void} setSelectNameValueList(selectNameValueList)
Sets the selectNameValueList value for this ParameterDefinition. To set the parameter definition paramdef to select the same name-value list as the parameter definition nparam, use code similar to the following:
	paramdef.setSelectNameValueList(nparam.getSelectNameValueList( ));
Parameters:
{actuate.parameter.NameValuePair[ ]} selectNameValueList
An array of actuate.parameter.NameValuePair objects.
Returns:
{void}
See:
actuate.parameter.NameValuePair

{void} setSelectValueList(selectValueList)
Sets the selectValueList value for this ParameterDefinition. To set the parameter definition paramdef to select the values 2007-2009, use code similar to the following:
	var values = new Array("2007", "2008", "2009");
	paramdef.setSelectValueList(values);
Parameters:
{Array} selectValueList
Returns:
{void}

{void} setStartExpanded(startExpanded)
Sets the startExpanded value for this ParameterDefinition.
Parameters:
{boolean} startExpanded
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 06 2015 04:13:44 GMT-0800 (PST)