ComplexTag

All Superinterfaces:: Comparable<Tag>, Tag

All Known Subinterfaces:: MutableComplexTag

All Known Implementing Classes:: ComplexTagDefinition

public interface ComplexTag extends Tag

Method Summary

Modifier and Type

Method

Description

TagPath

getFullyQualifiedType()

Returns the type id of this tag.

Member

getMember(String memberUid)

Returns the member of this complex tag with the given UID, or null if the member doesn't exist.

Collection<Member>

getMembers(boolean opaque)

If opaque, member config objects will already have overrides applied to them.

PropertySet

getOverrides(String memberUid)

Retrieves the overrides for the specified member of this complex type.

boolean

isTypeDef()

Returns whether this complex type is a type definition, or an instance.

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.Tag
getAccessRights, getAlarmStates, getAttribute, getCurrentValue, getDataType, getEventScripts, getName, getPermissionModel, getType, isEnabled

Method Details
- getFullyQualifiedType
  
  TagPath getFullyQualifiedType()
  
  Returns the type id of this tag. If the tag is an instance, will be the type of its parent.
- getMembers
  
  Collection<Member> getMembers(boolean opaque)
  
  If opaque, member config objects will already have overrides applied to them.
- getMember
  
  Member getMember(String memberUid)
  
  Returns the member of this complex tag with the given UID, or null if the member doesn't exist. However, if the memberUID is null, it returns a member for the root complex tag (a faux member, that is not included in the getMembers() results).
- isTypeDef
  
  boolean isTypeDef()
  
  Returns whether this complex type is a type definition, or an instance.
- getOverrides
  
  PropertySet getOverrides(String memberUid)
  
  Retrieves the overrides for the specified member of this complex type.