JSVariable

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Constants Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

DATETIME
Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

INTEGER
Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

MEDIA
Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

NUMBER
Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

TEXT
Constant to be used when the type of a variable needs to be specified.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

defaultValue
The default value of the variable.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

name
The name of the variable.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

variableType
The type of the variable.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

getScopeName()
Get scope name

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

UUID

Unknown macro: {td}

getUUID()
Returns the UUID of the variable

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Constants Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

DATETIME

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var dateVar = solutionModel.newGlobalVariable('globals', 'gDate', JSVariable.DATETIME);
dateVar.defaultValue = 'now';
application.output(scopes.globals.gDate); // Prints the current date and time.

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

INTEGER

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var intVar = solutionModel.newGlobalVariable('globals', 'gInt', JSVariable.INTEGER);
intVar.defaultValue = 997;
application.output(scopes.globals.gInt); // Prints 997

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

MEDIA

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var mediaVar = solutionModel.newGlobalVariable('globals', 'gMedia', JSVariable.MEDIA);
mediaVar.defaultValue = 'new Array(1, 2, 3, 4)';
application.output(scopes.globals.gMedia); // Prints out the array with four elements.

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

NUMBER

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var numberVar = solutionModel.newGlobalVariable('globals', 'gNumber', JSVariable.NUMBER);
numberVar.defaultValue = 192.334;
application.output(scopes.globals.gNumber); // Prints 192.334

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

TEXT

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Constant to be used when the type of a variable needs to be specified.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var txtVar = solutionModel.newGlobalVariable('globals', 'gText', JSVariable.TEXT);
txtVar.defaultValue = '"some text"'; // Use two pairs of quotes if you want to assign a String as default value.
application.output(scopes.globals.gText); // Prints 'some text' (without quotes).

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

defaultValue

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The default value of the variable.

It is interpreted as a JS expression.

For form variables ,setting this property requires the form instances to be destroyed (history.remove("formName")).
If you want to use a default value for a newly created variable create the variable using the 3 parameter version newVariable(name,type,defaultValue).

For INTEGER variables it can be an integer constant, like 10 for example.
For NUMBER variables it can be a real constant, like 22.41. For DATETIME
variables it can be "now", or a JS expression like "new Date()". For TEXT
variables it can be any string surrounded with quotes, like "'some text'".

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var intVar = solutionModel.newGlobalVariable('globals', 'gInt', JSVariable.INTEGER);
intVar.defaultValue = 997;
application.output(scopes.globals.gInt); // Prints 997
var numberVar = solutionModel.newGlobalVariable('globals', 'gNumber', JSVariable.NUMBER);
numberVar.defaultValue = 192.334;
application.output(scopes.globals.gNumber); // Prints 192.334
var dateVar = solutionModel.newGlobalVariable('globals', 'gDate', JSVariable.DATETIME);
dateVar.defaultValue = 'now';
application.output(scopes.globals.gDate); // Prints the current date and time.
var txtVar = solutionModel.newGlobalVariable('globals', 'gText', JSVariable.TEXT);
txtVar.defaultValue = '"some text"'; // Use two pairs of quotes if you want to assign a String as default value.
application.output(scopes.globals.gText); // Prints 'some text' (without quotes).
var mediaVar = solutionModel.newGlobalVariable('globals', 'gMedia', JSVariable.MEDIA);
mediaVar.defaultValue = 'new Array(1, 2, 3, 4)';
application.output(scopes.globals.gMedia); // Prints out the array with four elements.

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

name

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The name of the variable.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var gVar = solutionModel.newGlobalVariable('globals', 'gtext', JSVariable.TEXT);
gVar.name = 'anotherName';
gVar.defaultValue = '"default text"';
// The next two lines will print the same output.
application.output(scopes.globals[gVar.name]);
application.output(scopes.globals.anotherName);

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

variableType

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

The type of the variable. Can be one of: TEXT, INTEGER, NUMBER, DATETIME or MEDIA.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var g = solutionModel.newGlobalVariable('globals', 'gtext',JSVariable.TEXT);
scopes.globals.gtext = 'some text';
g.variableType = JSVariable.DATETIME;
scopes.globals.gtext = 'another text'; // This will raise an error now, because the variable is not longer of type text.

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getScopeName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getScopeName

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get scope name

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var globalVariables = solutionModel.getGlobalVariables();
for (var i in globalVariables)
	application.output(globalVariables[i].name + ' is defined in scope ' + globalVariables[i].getScopeName());

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getUUID

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

UUID

Unknown macro: {span}

getUUID

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the UUID of the variable

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

UUID

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var dateVar = solutionModel.newGlobalVariable('globals', 'gDate', JSVariable.DATETIME);
application.output(dateVar.getUUID().toString());

Unknown macro: {tr}

Unknown macro: {td}

Child pages

JSVariable

DATETIME

INTEGER

MEDIA

NUMBER

TEXT

defaultValue

name

variableType

getScopeName

getUUID