Package com.uc4.api.objects
Class CompositeVariable
java.lang.Object
com.uc4.api.objects.CompositeVariable
This class represents the panel "Variable" of an VARA Object with the source "Composite".
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum for the operation.Returns the result format.Returns the name of the first variable.Returns the name of the first variable.void
setOperation
(CompositeVariable.Operation operation) Sets the operation which is used for variable 1 and variable 2.void
setResultFormat
(String resultFormat) Sets the result format.void
setVariable1
(UC4ObjectName variable1) Sets the name of the first variable.void
setVariable2
(UC4ObjectName variable2) Sets the name of the first variable.protected void
-
Constructor Details
-
CompositeVariable
protected CompositeVariable(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
store
-
getVariable1
Returns the name of the first variable. If not set an emptyUC4ObjectName
instance is returned.- Returns:
- Name of the first variable, never null
-
setVariable1
Sets the name of the first variable. Ifnull
is passed as argument the field for variable 1 is not set.- Parameters:
variable1
- Variable name
-
getVariable2
Returns the name of the first variable. If not set an emptyUC4ObjectName
instance is returned.- Returns:
- Name of the second variable, never null
-
setVariable2
Sets the name of the first variable. Ifnull
is passed as argument the field for variable 2 is not set.- Parameters:
variable2
- Variable name
-
getResultFormat
Returns the result format.- Returns:
- Result format
-
setResultFormat
Sets the result format. The maximum length is 1024 characters.- Parameters:
resultFormat
- String which contains the result format
-
getOperation
Returns the enum for the operation.- Returns:
- Operation
-
setOperation
Sets the operation which is used for variable 1 and variable 2. ThrowsIllegalArgumentException
if operation is null.- Parameters:
operation
- Enum constant
-