com.uc4.api.objects

Class CompositeVariable

java.lang.Object

com.uc4.api.objects.CompositeVariable

public class CompositeVariable
extends Object

This class represents the panel "Variable" of an VARA Object with the source "Composite".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositeVariable.Operation Operation.

Method Summary

Modifier and Type	Method and Description
CompositeVariable.Operation	getOperation() Returns the enum for the operation.
String	getResultFormat() Returns the result format.
UC4ObjectName	getVariable1() Returns the name of the first variable.
UC4ObjectName	getVariable2() 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVariable1

public UC4ObjectName getVariable1()

Returns the name of the first variable. If not set an empty UC4ObjectName instance is returned.

Returns:

Name of the first variable, never null

setVariable1

public void setVariable1(UC4ObjectName variable1)

Sets the name of the first variable. If null is passed as argument the field for variable 1 is not set.

Parameters:

variable1 - Variable name

getVariable2

public UC4ObjectName getVariable2()

Returns the name of the first variable. If not set an empty UC4ObjectName instance is returned.

Returns:

Name of the second variable, never null

setVariable2

public void setVariable2(UC4ObjectName variable2)

Sets the name of the first variable. If null is passed as argument the field for variable 2 is not set.

Parameters:

variable2 - Variable name

getResultFormat

public String getResultFormat()

Returns the result format.

Returns:

Result format

setResultFormat

public void setResultFormat(String resultFormat)

Sets the result format. The maximum length is 1024 characters.

Parameters:

resultFormat - String which contains the result format

getOperation

public CompositeVariable.Operation getOperation()

Returns the enum for the operation.

Returns:

Operation

setOperation

public void setOperation(CompositeVariable.Operation operation)

Sets the operation which is used for variable 1 and variable 2. Throws IllegalArgumentException if operation is null.

Parameters:

operation - Enum constant