Package com.thingworx.entities

Class EntityReference

java.lang.Object

com.thingworx.entities.EntityReference

All Implemented Interfaces:

Comparable<EntityReference>

Direct Known Subclasses:

SecurityContext

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class EntityReference
extends Object
implements Comparable<EntityReference>

A class meant to be a slimmed down way of passing around a reference to an Entity. It contains the minimal amount of information needed to look up the Entity if inflation is necessary. This class should be used when passing around the fully inflated Entity Instance is not necessary.

Constructor Summary

Constructors

Constructor	Description
EntityReference()
EntityReference(RootEntity entity)
EntityReference(String name, short code)
EntityReference(String name, RelationshipTypes.ThingworxRelationshipTypes type)
EntityReference(String name, String type)

Method Summary

Modifier and Type	Method	Description
int	compareTo(EntityReference that)
static EntityReference	findByName(String name, RelationshipTypes.ThingworxRelationshipTypes type)
String	getDescription()
String	getEntityName()
String	getName()
RootEntity	getReference()	Returns the entity object referenced by the name and type.
String	getSubEntityName()	Get the sub entity from the full name set in this EntityReference.
RelationshipTypes.ThingworxRelationshipTypes	getType()
boolean	matches(EntityReference entityReference)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

EntityReference

@ThingworxExtensionApiMethod(since={6,6})
public EntityReference()

EntityReference

@ThingworxExtensionApiMethod(since={6,6})
public EntityReference(RootEntity entity)

EntityReference

@ThingworxExtensionApiMethod(since={6,6})
public EntityReference(String name,
 RelationshipTypes.ThingworxRelationshipTypes type)

EntityReference

@ThingworxExtensionApiMethod(since={6,6})
public EntityReference(String name,
 short code)

EntityReference

@ThingworxExtensionApiMethod(since={6,6})
public EntityReference(String name,
 String type)

Method Details

getType

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

getName

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

getReference

@ThingworxExtensionApiMethod(since={6,6})
public RootEntity getReference()

Returns the entity object referenced by the name and type. Visibility permissions to the entity will be checked.

Returns:

the referenced RootEntity or null if the entity does not exist or the current user does not have visibility to that entity.

getEntityName

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

getSubEntityName

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

Get the sub entity from the full name set in this EntityReference. Organizations names are typically found to have the organizational unit appended on the end.

Returns:

the sub entity name, or null if one was not found

getDescription

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

findByName

@ThingworxExtensionApiMethod(since={6,6})
public static EntityReference findByName(String name,
 RelationshipTypes.ThingworxRelationshipTypes type)
                                  throws Exception

Throws:

Exception - If an error occurs

matches

@ThingworxExtensionApiMethod(since={6,6})
public boolean matches(EntityReference entityReference)

toString

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

Overrides:

toString in class Object

compareTo

@ThingworxExtensionApiMethod(since={7,4})
public int compareTo(EntityReference that)

Specified by:

compareTo in interface Comparable<EntityReference>