Class MacroParameter

MacroParameter class

Syntax

Constructors

MacroParameter()

Initializes a new instance of the MacroParameter class.

Declaration

MacroParameter

MacroParameter(String,String,Map,String,String,Bool)

Initializes a new instance of the MacroParameter class.

Declaration

MacroParameter(String name, String type, Map controlConfig, String label, String description, Bool isOptional)

Parameters

Type	Name	Description
String	name	The name of the parameter.
String	type	The type of the parameter.
Map	controlConfig	The control configuration values the type of the parameter allows. Optional
String	label	The label of the parameter.
String	description	A longer description of the parameter.
Bool	isOptional	Whether the parameter is optional.

Returns

Type	Description

MacroParameter(String,String,Map,String,String,Bool,String,Bool)

Initializes a new instance of the MacroParameter class.

Declaration

MacroParameter(String name, String type, Map controlConfig, String label, String description, Bool isOptional, String defaultValue, Bool defaultValueIsFixed)

Parameters

Type	Name	Description
String	name	The name of the parameter.
String	type	The type of the parameter.
Map	controlConfig	The control configuration values the type of the parameter allows. Optional
String	label	The label of the parameter.
String	description	A longer description of the parameter.
Bool	isOptional	Whether the parameter is optional.
String	defaultValue
Bool	defaultValueIsFixed	Whether or not the default value of the parameter is fixed.

Returns

Type	Description

Methods

getControlConfig()

Gets the optional control configuration values that influence how the input control behaves.

Declaration

Map getControlConfig()

Returns

Type	Description
Map

getDescription()

Returns a longer description of the parameter.

Declaration

String getDescription()

Returns

Type	Description
String

Remarks

Can for instance be used as help in a form.

getIsFixedValue()

Returns true if the value is fixed, and false if it is read from another task or the environment.

Declaration

Bool getIsFixedValue()

Returns

Type	Description
Bool	True if the value is fixed; otherwise, false.

getIsOptional()

Returns true if the value is optional, and false if it is mandatory.

Declaration

Bool getIsOptional()

Returns

Type	Description
Bool	True if the value is optional; false if mandatory.

getLabel()

Returns the label for the parameter when displayed in a form.

Declaration

String getLabel()

Returns

Type	Description
String	The label for the parameter when displayed in a form.

getName()

Returns the name of the parameter.

Declaration

String getName()

Returns

Type	Description
String	The name of the parameter.

Remarks

The name is used for accessing the parameter.

getSourcePath()

Returns the source path of the object it is called from.

Declaration

String getSourcePath()

Returns

Type	Description
String	The source path of the object it is called from.

Examples

"loadTicket.id", "_environment.entryId"

getType()

Returns the type of the parameter.

Declaration

String getType()

Returns

Type	Description
String

Remarks

Used for displaying correct control in form. Available types:

• AnchorLine
• InfoFields
• Grid
• HR
• BR
• SubHeader
• ParserCode
• Messages
• EjScript
• HtmlGrid
• Planner
• StaticGrid
• DrillDown
• GenericGrid
• InfoFields2
• ExtraTableEntriesGrid
• DirectedAcyclicGraph
• EjscriptElement
• Chart
• WhereChart
• ListRecipients
• EntityCard

getValue()

If the parameter is a fixed value, this function will return that value.

Declaration

String getValue()

Returns

Type	Description
String

setControlConfig(Map)

Sets the optional configuration values for the type. The configuration will influence how the input control behaves.

Declaration

Void setControlConfig(Map values)

Parameters

Type	Name	Description
Map	values	Values to set.

Returns

Type	Description
Void

setDescription(String)

Sets a longer description of the parameter. This description can for instance be used in as help in a form.

Declaration

Void setDescription(String description)

Parameters

Type	Name	Description
String	description	The text to set.

Returns

Type	Description
Void

setIsFixedValue(Bool)

Sets whether or not the parameter is a fixed value.

Declaration

Void setIsFixedValue(Bool isFixed)

Parameters

Type	Name	Description
Bool	isFixed

Returns

Type	Description
Void

setIsOptional(Bool)

Sets whether or not the parameter is optional.

Declaration

Void setIsOptional(Bool isOptional)

Parameters

Type	Name	Description
Bool	isOptional

Returns

Type	Description
Void

setLabel(String)

Sets the label of the parameter when displayed in form.

Declaration

Void setLabel(String label)

Parameters

Type	Name	Description
String	label

Returns

Type	Description
Void

setName(String)

Sets the name of the parameter.

Declaration

Void setName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Void

Remarks

Parameters are accessed by their name.

setSourcePath(String)

Sets the parameter's source path.

Declaration

Void setSourcePath(String path)

Parameters

Type	Name	Description
String	path

Returns

Type	Description
Void

Examples

"loadTicket.id", "_environment.entryId"

setType(String)

Sets the type of the parameter.

Declaration

Void setType(String type)

Parameters

Type	Name	Description
String	type

Returns

Type	Description
Void

Remarks

Available types:

• AnchorLine
• InfoFields
• Grid
• HR
• BR
• SubHeader
• ParserCode
• Messages
• EjScript
• HtmlGrid
• Planner
• StaticGrid
• DrillDown
• GenericGrid
• InfoFields2
• ExtraTableEntriesGrid
• DirectedAcyclicGraph
• EjscriptElement
• Chart
• WhereChart
• ListRecipients
• EntityCard

setValue(String)

Sets the value of the parameter, given that the parameter is a fixed value.

Declaration

Void setValue(String value)

Parameters

Type	Name	Description
String	value

Returns

Type	Description
Void