com.siemens.mindsphere.sdk.assetmanagement.model

Class VariableDefinition

Object

VariableDefinition

All Implemented Interfaces:

Serializable

public class VariableDefinition
extends Object
implements Serializable

VariableDefinition

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariableDefinition.DataTypeEnum Data type of the variable.

Constructor Summary

Constructors

Constructor and Description
VariableDefinition()

Method Summary

Modifier and Type	Method and Description
VariableDefinition	dataType(VariableDefinition.DataTypeEnum dataType)
VariableDefinition	defaultValue(String defaultValue)
boolean	equals(Object o)
VariableDefinition.DataTypeEnum	getDataType() Data type of the variable.
String	getDefaultValue() The default value of the variable.
Integer	getLength() The max length of the variable's value.
String	getName() Name of the variable.
String	getUnit() Unit of measurement.
int	hashCode()
Boolean	isSearchable() Indicates whether sorting and filtering is allowed on this variable.
VariableDefinition	length(Integer length)
VariableDefinition	name(String name)
VariableDefinition	searchable(Boolean searchable)
void	setDataType(VariableDefinition.DataTypeEnum dataType)
void	setDefaultValue(String defaultValue)
void	setLength(Integer length)
void	setName(String name)
void	setSearchable(Boolean searchable)
void	setUnit(String unit)
String	toString()
VariableDefinition	unit(String unit)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableDefinition

public VariableDefinition()

Method Detail

name

public VariableDefinition name(String name)

getName

public String getName()

Name of the variable. Once set cannot be changed. Reserved words (id, name, description, tenant, etag, scope, properties, propertySets, extends, variables, aspects, parentTypeId) cannot be used as variable names.

Returns:

name

setName

public void setName(String name)

dataType

public VariableDefinition dataType(VariableDefinition.DataTypeEnum dataType)

getDataType

public VariableDefinition.DataTypeEnum getDataType()

Data type of the variable. BIG_STRING could only be used by variables in dynamic aspect-types. Cannot be changed.

Returns:

dataType

setDataType

public void setDataType(VariableDefinition.DataTypeEnum dataType)

unit

public VariableDefinition unit(String unit)

getUnit

public String getUnit()

Unit of measurement. Cannot be changed.

Returns:

unit

setUnit

public void setUnit(String unit)

searchable

public VariableDefinition searchable(Boolean searchable)

isSearchable

public Boolean isSearchable()

Indicates whether sorting and filtering is allowed on this variable. Only usable for static properties. Cannot be changed.

Returns:

searchable

setSearchable

public void setSearchable(Boolean searchable)

length

public VariableDefinition length(Integer length)

getLength

public Integer getLength()

The max length of the variable's value. The length field is only used for variables of string or big_string dataType. Max length for string is 255 and max length for big_string 100000. Cannot be changed. minimum: 1 maximum: 100000

Returns:

length

setLength

public void setLength(Integer length)

defaultValue

public VariableDefinition defaultValue(String defaultValue)

getDefaultValue

public String getDefaultValue()

The default value of the variable. It must be compatible with the dataType! The default value will be inherited by the asset type's child types and by the asset instantiating it. It can be defined in aspect types and asset types.

Returns:

defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object