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, java.io.Serializable, java.lang.Cloneable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class PropertyDefinition
extends FieldDefinition
implements ICategorizedObject, java.lang.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(java.lang.String name, java.lang.String description, BaseTypes baseType)

Method Summary

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

PropertyDefinition

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

Method Detail

getCategory

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

Specified by:

getCategory in interface ICategorizedObject

setCategory

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

Specified by:

setCategory in interface ICategorizedObject

isBuiltIn

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

isReadOnly

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

isRemote

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

isLogged

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

isIndexed

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

isLocalProperty

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

setLogged

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

setRemote

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

setReadOnly

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

setIndexed

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

getCacheTime

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

getDataChangeType

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

getDataChangeThreshold

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.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 java.lang.String getSourceName()