com.thingworx.types

Class TagCollection

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<TagLink>

com.thingworx.types.TagCollection

All Implemented Interfaces:

IDiffableObject, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<TagLink>, java.util.Collection<TagLink>, java.util.List<TagLink>, java.util.RandomAccess

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class TagCollection
extends java.util.ArrayList<TagLink>
implements IDiffableObject

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
TagCollection()

Method Summary

Modifier and Type	Method and Description
void	AddTag(java.lang.String vocabulary, java.lang.String vocabularyTerm)
void	addTag(TagLink newTag)
void	addTags(TagCollection newTags)
static boolean	areEquivalent(TagCollection t1, TagCollection t2)
TagCollection	clone()
int	compareTo(TagCollection tags)
boolean	contains(TagLink tagLink)
java.lang.Boolean	ContainsTerm(java.lang.String vocabularyName, java.lang.String vocabularyTerm)
static TagCollection	fromJSON(org.json.JSONArray jsonArray)
static TagCollection	fromString(java.lang.String serializedTags)
int	getLength()
java.lang.String	GetTerm(java.lang.String vocabularyName)
ScriptFriendlyArrayList<java.lang.String>	GetTerms(java.lang.String vocabularyName)
int	indexOf(TagLink tagLink)
boolean	matches(TagCollection tagsToCompare)
boolean	matchesOR(TagCollection tagsToCompare)
void	RemoveTag(java.lang.String vocabulary, java.lang.String vocabularyTerm)
void	removeTag(TagLink tag)
org.json.JSONArray	toJSON()
java.lang.String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

TagCollection

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

Method Detail

fromString

@ThingworxExtensionApiMethod(since={6,6})
public static TagCollection fromString(java.lang.String serializedTags)
                                                                          throws java.lang.Exception

Throws:

java.lang.Exception - If an error occurs

contains

@ThingworxExtensionApiMethod(since={6,6})
public boolean contains(TagLink tagLink)

indexOf

@ThingworxExtensionApiMethod(since={6,6})
public int indexOf(TagLink tagLink)

ContainsTerm

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean ContainsTerm(java.lang.String vocabularyName,
                                                                                java.lang.String vocabularyTerm)

GetTerm

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

GetTerms

@ThingworxExtensionApiMethod(since={6,6})
public ScriptFriendlyArrayList<java.lang.String> GetTerms(java.lang.String vocabularyName)

AddTag

@ThingworxExtensionApiMethod(since={6,6})
public void AddTag(java.lang.String vocabulary,
                                                             java.lang.String vocabularyTerm)

removeTag

@ThingworxExtensionApiMethod(since={6,6})
public void removeTag(TagLink tag)

RemoveTag

@ThingworxExtensionApiMethod(since={6,6})
public void RemoveTag(java.lang.String vocabulary,
                                                                java.lang.String vocabularyTerm)

addTag

@ThingworxExtensionApiMethod(since={6,6})
public void addTag(TagLink newTag)

addTags

@ThingworxExtensionApiMethod(since={6,6})
public void addTags(TagCollection newTags)

getLength

@ThingworxExtensionApiMethod(since={6,6})
public int getLength()

toString

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

Overrides:

toString in class java.util.AbstractCollection<TagLink>

matches

@ThingworxExtensionApiMethod(since={6,6})
public boolean matches(TagCollection tagsToCompare)

matchesOR

@ThingworxExtensionApiMethod(since={6,6})
public boolean matchesOR(TagCollection tagsToCompare)

compareTo

@ThingworxExtensionApiMethod(since={6,6})
public int compareTo(TagCollection tags)

clone

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

Overrides:

clone in class java.util.ArrayList<TagLink>

areEquivalent

@ThingworxExtensionApiMethod(since={6,6})
public static boolean areEquivalent(TagCollection t1,
                                                                              TagCollection t2)

fromJSON

@ThingworxExtensionApiMethod(since={6,6})
public static TagCollection fromJSON(org.json.JSONArray jsonArray)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception - If an error occurs

toJSON

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONArray toJSON()
                                                                    throws java.lang.Exception

Throws:

java.lang.Exception - If an error occurs