Package com.thingworx.metadata

Class PropertyDefinition

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.metadata.FieldDefinition

com.thingworx.metadata.PropertyDefinition

All Implemented Interfaces:

ISupportsAccessModifier, ISupportsDeprecation, IDiffableObject, ICategorizedObject, IAspectContainer, INamedObject, Serializable, Cloneable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class PropertyDefinition
extends FieldDefinition
implements ICategorizedObject, Cloneable, ISupportsAccessModifier, ISupportsDeprecation

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
PropertyDefinition(String name, String description, BaseTypes baseType)

Method Summary

Modifier and Type	Method	Description
PropertyDefinition	clone()	Creates a deep clone of this field definition.
Integer	getCacheTime()
String	getCategory()
Double	getDataChangeThreshold()
DataChangeType	getDataChangeType()
String	getSourceName()
RelationshipTypes.ThingworxRelationshipTypes	getSourceType()
Boolean	isBuiltIn()
Boolean	isIndexed()
Boolean	isLocalProperty()
Boolean	isLogged()
Boolean	isReadOnly()
boolean	isRemote()
void	setCategory(String category)
void	setIndexed(Boolean value)
void	setLogged(Boolean value)
void	setReadOnly(Boolean value)
void	setRemote(Boolean value)

Methods inherited from class com.thingworx.metadata.FieldDefinition

aspectsMatch, getAspects, getBaseType, getDataShapeName, getDefaultValue, getOrdinal, hasDataShape, hasDefaultValue, isContentCrawlerEntry, isDataTableEntry, isPrimaryKey, isPrivate, isQueryParameter, isRequired, isStreamEntry, setAspects, setBaseType, setOrdinal

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.accesscontrol.ISupportsAccessModifier

getAccessModifier, getAccessModifierScope, getExemptList, hasAccessModifier, isInternalAccess, isPrivateAccess, isRestrictedAccess

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

PropertyDefinition

@ThingworxExtensionApiMethod(since={6,6})
public PropertyDefinition(String name,
 String description,
 BaseTypes baseType)

Method Details

getCategory

@ThingworxExtensionApiMethod(since={6,6})
public String getCategory()

Specified by:

getCategory in interface ICategorizedObject

setCategory

@ThingworxExtensionApiMethod(since={6,6})
public void setCategory(String category)

Specified by:

setCategory in interface ICategorizedObject

isBuiltIn

@ThingworxExtensionApiMethod(since={6,6})
public Boolean isBuiltIn()

isReadOnly

@ThingworxExtensionApiMethod(since={6,6})
public Boolean isReadOnly()

isRemote

@ThingworxExtensionApiMethod(since={6,6})
public boolean isRemote()

isLogged

@ThingworxExtensionApiMethod(since={6,6})
public Boolean isLogged()

isIndexed

@ThingworxExtensionApiMethod(since={9,3})
public Boolean isIndexed()

isLocalProperty

@ThingworxExtensionApiMethod(since={9,0})
public Boolean isLocalProperty()

setLogged

@ThingworxExtensionApiMethod(since={6,6})
public void setLogged(Boolean value)

setRemote

@ThingworxExtensionApiMethod(since={6,6})
public void setRemote(Boolean value)

setReadOnly

@ThingworxExtensionApiMethod(since={6,6})
public void setReadOnly(Boolean value)

setIndexed

@ThingworxExtensionApiMethod(since={9,3})
public void setIndexed(Boolean value)

getCacheTime

@ThingworxExtensionApiMethod(since={6,6})
public Integer getCacheTime()

getDataChangeType

@ThingworxExtensionApiMethod(since={6,6})
public DataChangeType getDataChangeType()

getDataChangeThreshold

@ThingworxExtensionApiMethod(since={6,6})
public Double getDataChangeThreshold()

clone

@ThingworxExtensionApiMethod(since={6,6})
public PropertyDefinition clone()

Description copied from class: FieldDefinition

Creates a deep clone of this field definition.

Overrides:

clone in class FieldDefinition

Returns:

a clone of this field definition

getSourceType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getSourceType()

getSourceName

@ThingworxExtensionApiMethod(since={6,6})
public String getSourceName()