Classes


Class actuate.parameter.ParameterDefinition

ParameterDefinition represents a javascript version of com.actuate.schemas.ParameterDefinition.
Member of: actuate.parameter.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a new ParameterDefinition object.
Method Summary
Method Attributes Method Name and Description
 
Gets the auto suggest 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 dataType value for this ParameterDefinition.
 
Gets the defaultValue value for this ParameterDefinition.
 
gets the flag if the default value is null for this ParameterDefinition.
 
Gets the displayName value for this ParameterDefinition.
 
Gets the group value for this ParameterDefinition.
 
Gets the helpText value for this ParameterDefinition.
 
Gets the name value for this ParameterDefinition.
 
Gets the position value for this ParameterDefinition.
 
Gets the selectNameValueList value for this ParameterDefinition.
 
Gets the selectValueList 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 auto suggest threshold value for this ParameterDefinition.
 
setCascadingParentName(cascadingParentName)
Sets the cascadingParentName value for this ParameterDefinition.
 
setColumnName(columnName)
Sets the columnName value for this ParameterDefinition.
 
setColumnType(columnType)
Sets the columnType value for this ParameterDefinition.
 
setControlType(controlType)
Sets the controlType value for this ParameterDefinition.
 
setDataType(dataType)
Sets the dataType value for this ParameterDefinition.
 
setDefaultValue(defaultValue)
Sets the defaultValue value for this ParameterDefinition.
 
Sets the flag whether the default value is null or not value for this ParameterDefinition.
 
setDisplayName(displayName)
Sets the displayName value for this ParameterDefinition.
 
setGroup(group)
Sets the group value for this ParameterDefinition.
 
setHelpText(helpText)
Sets the helpText value for this ParameterDefinition.
 
setIsAdHoc(isAdHoc)
Sets the isAdHoc value for this ParameterDefinition.
 
setIsHidden(isHidden)
Sets the isHidden value for this ParameterDefinition.
 
setIsPassword(isPassword)
Sets the isPassword value for this ParameterDefinition.
 
setIsRequired(isRequired)
Sets the isRequired value for this ParameterDefinition.
 
setIsViewParameter(isViewParameter)
Sets the isViewParameter value for this ParameterDefinition.
 
setName(name)
Sets the name value 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.
Class Detail
actuate.parameter.ParameterDefinition()
Constructs a new ParameterDefinition object.
Method Detail
{Integer} getAutoSuggestThreshold()
Gets the auto suggest threshold value for this ParameterDefinition.
Returns:
{Integer} threshold

{String} getCascadingParentName()
Gets the cascadingParentName value for this ParameterDefinition.
Returns:
{String} cascadingParentName

{String} getColumnName()
Gets the columnName value for this ParameterDefinition.
Returns:
{String} columnName

{String} getColumnType()
Gets the columnType value for this ParameterDefinition.
Possible values are:
"Currency", "Date", "DateOnly", "Time", "Double", "Integer",
"String", "Boolean", "Structure", "Table", "Unknown"
Returns:
{String} columnType

{String} getControlType()
Gets the controlType value for this ParameterDefinition.
Possible values are:
null, "", "AutoSuggest", "ControlRadioButton", "ControlList",
"ControlListAllowNew", "ControlCheckBox"
Returns:
{String} controlType

{String} getDataType()
Gets the dataType value for this ParameterDefinition.
Possible values are:
"Currency", "Date", "DateOnly", "Time", "Double", "Integer",
"String", "Boolean", "Structure", "Table", "Unknown"
Returns:
{String} dataType

{String} getDefaultValue()
Gets the defaultValue value for this ParameterDefinition.
Returns:
{String} defaultValue

{boolean} getDefaultValueIsNull()
gets the flag if the default value is null for this ParameterDefinition.
Returns:
{boolean}

{String} getDisplayName()
Gets the displayName value for this ParameterDefinition.
Returns:
{String} displayName

{String} getGroup()
Gets the group value for this ParameterDefinition.
Returns:
{String} group

{String} getHelpText()
Gets the helpText value for this ParameterDefinition.
Returns:
{String} helpText

{String} getName()
Gets the name value for this ParameterDefinition.
Returns:
{String} name

{Integer} getPosition()
Gets the position value for this ParameterDefinition.
Returns:
{Integer} position

{Array} getSelectNameValueList()
Gets the selectNameValueList value for this ParameterDefinition.
Returns:
{Array} selectNameValueList An array of actuate.parameter.NameValuePair.
See:
actuate.parameter.NameValuePair

{Array} getSelectValueList()
Gets the selectValueList value for this ParameterDefinition.
Returns:
{Array} selectValueList An array of String

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

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

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

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

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

{void} setAutoSuggestThreshold(threshold)
Sets the auto suggest threshold value for this ParameterDefinition.
Parameters:
{Integer} threshold
Returns:
{void}

{void} setCascadingParentName(cascadingParentName)
Sets the cascadingParentName value for this ParameterDefinition.
Parameters:
{String} cascadingParentName
Returns:
{void}

{void} setColumnName(columnName)
Sets the columnName value for this ParameterDefinition.
Possible values are:
"Currency", "Date", "DateOnly", "Time", "Double", "Integer",
"String", "Boolean", "Structure", "Table", "Unknown"
Parameters:
{String} columnName
Returns:
{void}

{void} setColumnType(columnType)
Sets the columnType value for this ParameterDefinition.
Parameters:
{String} columnType
Returns:
{void}

{void} setControlType(controlType)
Sets the controlType value for this ParameterDefinition.
Possible values are:
null, "", "AutoSuggest", "ControlRadioButton", "ControlList",
"ControlListAllowNew", "ControlCheckBox"
Parameters:
{String} controlType
Returns:
{void}

{void} setDataType(dataType)
Sets the dataType value for this ParameterDefinition.
Possible values are:
"Currency", "Date", "DateOnly", "Time", "Double", "Integer",
"String", "Boolean", "Structure", "Table", "Unknown"
Parameters:
{String} dataType
Returns:
{void}

{void} setDefaultValue(defaultValue)
Sets the defaultValue value for this ParameterDefinition.
Parameters:
{String} defaultValue
Returns:
{void}

{void} setDefaultValueIsNull(value)
Sets the flag whether the default value is null or not value for this ParameterDefinition.
Parameters:
{boolean} value
Returns:
{void}

{void} setDisplayName(displayName)
Sets the displayName value for this ParameterDefinition.
Parameters:
{String} displayName
Returns:
{void}

{void} setGroup(group)
Sets the group value for this ParameterDefinition.
Parameters:
{String} group
Returns:
{void}

{void} setHelpText(helpText)
Sets the helpText value for this ParameterDefinition.
Parameters:
{String} helpText
Returns:
{void}

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

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

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

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

setIsViewParameter(isViewParameter)
Sets the isViewParameter value for this ParameterDefinition.
Parameters:
{boolean} isViewParameter
return {void}

{void} setName(name)
Sets the name value for this ParameterDefinition.
Parameters:
{String} name
Returns:
{void}

{void} setPosition(position)
Sets the position value for this ParameterDefinition.
Parameters:
{Integer} position
Returns:
{void}

{void} setSelectNameValueList(selectNameValueList)
Sets the selectNameValueList value for this ParameterDefinition.
Parameters:
{Array} selectNameValueList
An array of actuate.parameter.NameValuePair
Returns:
{void}
See:
actuate.parameter.NameValuePair

{void} setSelectValueList(selectValueList)
Sets the selectValueList value for this ParameterDefinition.
Parameters:
{Array} selectValueList
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:27 GMT-0800 (PST)