Interface: IRuntimeVariable

Package: com.phoenix_int.pacz.api.v2

All Superinterfaces

• IPHXType
• IPHXType2
• IPHXUnits
• com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata

---

Declaration:

public interface IRuntimeVariable
extends IPHXType2, IPHXUnits, com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata

Component variable interface

Nested Class Summary

Nested classes/interfaces inherited from interface com.phoenix_int.aserver.types.IPHXType2

IPHXType2.IVisitor<t>

Method Summary

Modifier and Type	Method and Description
IRuntimeVariable	createCopy() Get a clone of this variable, including its metadata and value.
java.lang.String	getDescription() Get variable description
java.util.Map<java>	getMetaData() Get additional variable meta data
java.lang.String	getType() Get variable data type
java.lang.String	getVariableName() Get variable name
boolean	isArray() Whether or not variable is an array type
boolean	isEnum() Whether or not variable is an enumerated type
boolean	isNumeric() Whether or not variable is a numeric type
void	setDescription(java.lang.String description) Set variable description
void	setMetaData(java.lang.String key, java.lang.String value) Set meta data property; will create a new entry if it does not exist
void	setVariableName(java.lang.String name) Set variable name
PHXSimpleType	toPHXSimpleType() Get the PHXSimpleType version of variable

Methods inherited from interface com.phoenix_int.aserver.types.IPHXType2

Accept, fromString2, toString2

Methods inherited from interface com.phoenix_int.aserver.types.IPHXType

fromString, toString

Methods inherited from interface com.phoenix_int.aserver.types.IPHXUnits

getUnits, setUnits

Methods inherited from interface com.phoenix_int.pacz.api.v2.IRuntimeVariableMetadata

getOptionalEnumAliases, getOptionalEnumValues, getOptionalFormat, getOptionalLowerBound, getOptionalUpperBound

Method Detail

getVariableName

java.lang.String getVariableName()

Get variable name

Returns:

• variable name

setVariableName

void setVariableName(java.lang.String name)

Set variable name

Parameters:

• name - variable name to use

getDescription

java.lang.String getDescription()

Get variable description

Returns:

• description of variable

setDescription

void setDescription(java.lang.String description)

Set variable description

Parameters:

• description - description of variable to use

getType

java.lang.String getType()

Get variable data type

Returns:

• variable data type

See Also:

• PHXTypeFactory.getVarType(java.lang.String)

getMetaData

java.util.Map<java> getMetaData()

Get additional variable meta data

Returns:

• key-value pair of variable meta data

setMetaData

void setMetaData(java.lang.String key, 
                 java.lang.String value)
          throws java.lang.IllegalArgumentException

Set meta data property; will create a new entry if it does not exist

Parameters:

• key - meta data property for which to set value
• value - value to set

Throws:

• java.lang.IllegalArgumentException - if key is null or empty

isNumeric

boolean isNumeric()

Whether or not variable is a numeric type

Returns:

• true if numeric type, false otherwise

isArray

boolean isArray()

Whether or not variable is an array type

Returns:

• true if array type, false otherwise

isEnum

boolean isEnum()

Whether or not variable is an enumerated type

Returns:

• true if enumerated type, false otherwise

toPHXSimpleType

PHXSimpleType toPHXSimpleType()

Get the PHXSimpleType version of variable

Returns:

• PHXSimpleType version of variable

createCopy

IRuntimeVariable createCopy()

Get a clone of this variable, including its metadata and value.

Returns:

• a newly constructed clone of the instance.