Interface: IRuntimeVariable

Package: com.phoenix_int.pacz.api

---

Deprecated: see com.phoenix_int.pacz.api.v2.IRuntimeVariable

@Deprecated
public interface IRuntimeVariable

Component variable interface

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultValue() Deprecated. Get default value of variable
java.lang.String	getDescription() Deprecated. Get variable description
java.lang.String[]	getEnumAliases() Deprecated. Get names/aliases for the enumerated type
java.lang.Object[]	getEnumValues() Deprecated. Get values for the enumerated type
java.lang.String	getFormat() Deprecated. Get variable format string
java.lang.Number	getLowerBound() Deprecated. Get lower bound of variable; may be null
java.util.Map<java>	getMetaData() Deprecated. Get additional variable meta data
java.lang.String	getName() Deprecated. Get variable name
VariableDataType	getType() Deprecated. Get variable data type
java.lang.String	getUnits() Deprecated. Get variable units
java.lang.Number	getUpperBound() Deprecated. Get upper bound of variable; may be null
boolean	isArray() Deprecated. Whether or not variable is an array type
boolean	isEnum() Deprecated. Whether or not variable is an enumerated type
boolean	isNumeric() Deprecated. Whether or not variable is a numeric type
void	setDefaultValue(java.lang.Object defaultValue) Deprecated. Set default value of variable
void	setDescription(java.lang.String description) Deprecated. Set variable description
void	setEnums(java.lang.String[] enumAliases, java.lang.Object[] enumValues) Deprecated. Set the names/aliases and corresponding values for the enumerated type
void	setFormat(java.lang.String format) Deprecated. Set variable format string
void	setLowerBound(java.lang.Number lowerBound) Deprecated. Set lower bound of variable; may be null
void	setMetaData(java.lang.String key, java.lang.String value) Deprecated. Set meta data property; will create a new entry it does not exist
void	setName(java.lang.String name) Deprecated. Set variable name
void	setUnits(java.lang.String units) Deprecated. Set variable units
void	setUpperBound(java.lang.Number upperBound) Deprecated. Set upper bound of variable; may be null

Method Detail

getName

java.lang.String getName()

Deprecated. Get variable name

Returns:

• variable name

setName

void setName(java.lang.String name)

Deprecated. Set variable name

Parameters:

• name - variable name to use

getType

VariableDataType getType()

Deprecated. Get variable data type

Returns:

• variable data type

See Also:

• VariableDataType

getFormat

java.lang.String getFormat()

Deprecated. Get variable format string

Returns:

• variable format string

setFormat

void setFormat(java.lang.String format)

Deprecated. Set variable format string

Parameters:

• format - format string to use

getUnits

java.lang.String getUnits()

Deprecated. Get variable units

Returns:

• variable units

setUnits

void setUnits(java.lang.String units)

Deprecated. Set variable units

Parameters:

• units - units to use

getDescription

java.lang.String getDescription()

Deprecated. Get variable description

Returns:

• variable description

setDescription

void setDescription(java.lang.String description)

Deprecated. Set variable description

Parameters:

• description - description to use

getDefaultValue

java.lang.Object getDefaultValue()

Deprecated. Get default value of variable

Returns:

• variable default value

setDefaultValue

void setDefaultValue(java.lang.Object defaultValue)

Deprecated. Set default value of variable

Parameters:

• defaultValue - default value to use

getUpperBound

java.lang.Number getUpperBound()

Deprecated. Get upper bound of variable; may be null

Only applicable to variables of numeric type

Returns:

• variable upper bound or null if no upper bound

setUpperBound

void setUpperBound(java.lang.Number upperBound)

Deprecated. Set upper bound of variable; may be null

Only applicable to variables of numeric type

Parameters:

• upperBound - upper bound to use; null for none

getLowerBound

java.lang.Number getLowerBound()

Deprecated. Get lower bound of variable; may be null

Only applicable to variables of numeric type

Returns:

• variable lower bound or null if no lower bound

setLowerBound

void setLowerBound(java.lang.Number lowerBound)

Deprecated. Set lower bound of variable; may be null

Only applicable to variables of numeric type

Parameters:

• lowerBound - lower bound to use; null for none

getEnumValues

java.lang.Object[] getEnumValues()

Deprecated. Get values for the enumerated type

Returns:

• array of values for the enumerated type or null if variable is not an enumerated type

getEnumAliases

java.lang.String[] getEnumAliases()

Deprecated. Get names/aliases for the enumerated type

Returns:

• array of names/aliases for the enumerated type or null if variable is not an enumerated type

setEnums

void setEnums(java.lang.String[] enumAliases, 
              java.lang.Object[] enumValues)

Deprecated. Set the names/aliases and corresponding values for the enumerated type

Parameters:

• enumAliases - array of names/aliases of enumerated type; must have same length as values
• enumValues - array of values of enumerated type; must have same length as aliases

Throws:

• java.lang.IllegalArgumentException - if aliases and values are not of same length

getMetaData

java.util.Map<java> getMetaData()

Deprecated. 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

Deprecated. Set meta data property; will create a new entry 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()

Deprecated. Whether or not variable is a numeric type

Returns:

• true if numeric type, false otherwise

isArray

boolean isArray()

Deprecated. Whether or not variable is an array type

Returns:

• true if array type, false otherwise

isEnum

boolean isEnum()

Deprecated. Whether or not variable is an enumerated type

Returns:

• true if enumerated type, false otherwise