Package com.microstrategy.web.objects
Class WebScriptVariable
- java.lang.Object
 - 
- com.microstrategy.web.objects.WebScriptVariable
 
 
- 
public class WebScriptVariable extends java.lang.Object 
- 
- 
Constructor Summary
Constructors Constructor Description WebScriptVariable() 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbuildXMLBody(WebXMLBuilder builder)build the xml body for script variablestatic WebScriptVariablecreateWebScriptVariable()create the WebScriptVariable instancestatic WebScriptVariablecreateWebScriptVariable(org.xml.sax.Attributes attrs)restore the script variable object from the xml attrsjava.lang.StringgetDefaultValue()get the DefaultValue of the variablejava.lang.StringgetDesc()get the desc of the variablejava.lang.StringgetId()get the id of the variablejava.lang.StringgetName()get the name of the variablejava.lang.StringgetRefId()get the refId of the variableintgetRefType()Returns the ref object typeintgetVariableType()Returns the variable typebooleanhasObjectReference()booleanisAllowEmptyValue()Returns whether allow emptybooleanisMultipleValue()Returns whether multiplebooleanisPrompt()get the isPrompt of the variablebooleanisRequired()get the isTransactionColumn of the variablebooleanisSecretValueChanged()get the secret value changed or notbooleanisTransactionColumn()get the isTransactionColumn of the variablevoidsetAllowEmptyValue(boolean allowEmpty)Set allow emptyvoidsetDefaultValue(java.lang.String defaultValue)set the DefaultValue of the variablevoidsetDesc(java.lang.String desc)set the desc of the variablevoidsetId(java.lang.String id)set the id of the variablevoidsetMultipleValue(boolean multiple)Set multiplevoidsetName(java.lang.String name)set the name of the variablevoidsetPrompt(boolean isPrompt)Set isPromptvoidsetRefId(java.lang.String refId)set the refId of the variablevoidsetRefType(int refType)Set or modify the variable typevoidsetRequired(boolean isRequired)Set isTransactionColumnvoidsetSecretValueChanged(boolean isSecretValueChanged)get the secret value changed or notvoidsetTransactionColumn(boolean isTransactionColumn)Set isTransactionColumnvoidsetVariableType(int type)Set or modify the variable type 
 - 
 
- 
- 
Method Detail
- 
setId
public void setId(java.lang.String id)
set the id of the variable 
- 
getId
public java.lang.String getId()
get the id of the variable 
- 
setName
public void setName(java.lang.String name)
set the name of the variable 
- 
getName
public java.lang.String getName()
get the name of the variable 
- 
getVariableType
public int getVariableType()
Returns the variable type 
- 
setVariableType
public void setVariableType(int type)
Set or modify the variable type 
- 
isAllowEmptyValue
public boolean isAllowEmptyValue()
Returns whether allow empty 
- 
setAllowEmptyValue
public void setAllowEmptyValue(boolean allowEmpty)
Set allow empty 
- 
isMultipleValue
public boolean isMultipleValue()
Returns whether multiple 
- 
setMultipleValue
public void setMultipleValue(boolean multiple)
Set multiple 
- 
setDesc
public void setDesc(java.lang.String desc)
set the desc of the variable 
- 
getDesc
public java.lang.String getDesc()
get the desc of the variable 
- 
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
set the DefaultValue of the variable 
- 
getDefaultValue
public java.lang.String getDefaultValue()
get the DefaultValue of the variable 
- 
setPrompt
public void setPrompt(boolean isPrompt)
Set isPrompt 
- 
isPrompt
public boolean isPrompt()
get the isPrompt of the variable 
- 
isSecretValueChanged
public boolean isSecretValueChanged()
get the secret value changed or not 
- 
setTransactionColumn
public void setTransactionColumn(boolean isTransactionColumn)
Set isTransactionColumn 
- 
isTransactionColumn
public boolean isTransactionColumn()
get the isTransactionColumn of the variable 
- 
setRequired
public void setRequired(boolean isRequired)
Set isTransactionColumn 
- 
isRequired
public boolean isRequired()
get the isTransactionColumn of the variable 
- 
setRefId
public void setRefId(java.lang.String refId)
set the refId of the variable 
- 
getRefId
public java.lang.String getRefId()
get the refId of the variable 
- 
getRefType
public int getRefType()
Returns the ref object type 
- 
setRefType
public void setRefType(int refType)
Set or modify the variable type 
- 
hasObjectReference
public boolean hasObjectReference()
 
- 
setSecretValueChanged
public void setSecretValueChanged(boolean isSecretValueChanged)
get the secret value changed or not 
- 
buildXMLBody
public void buildXMLBody(WebXMLBuilder builder)
build the xml body for script variable 
- 
createWebScriptVariable
public static WebScriptVariable createWebScriptVariable(org.xml.sax.Attributes attrs)
restore the script variable object from the xml attrs 
- 
createWebScriptVariable
public static WebScriptVariable createWebScriptVariable()
create the WebScriptVariable instance 
 - 
 
 -