MutableComplexTag

All Superinterfaces:: Comparable<Tag>, ComplexTag, Tag

All Known Implementing Classes:: ComplexTagDefinition

public interface MutableComplexTag extends ComplexTag

Method Summary

Modifier and Type

Method

Description

List<Member>

addMember(String parentFolderUid, Tag member)

Adds a member to this type, located at the specified folder path.

void

removeMember(String memberUid)

Removes the given member from this complex tag object.

void

setName(String name)

Sets the name of the type or instance.

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.udt.ComplexTag
getFullyQualifiedType, getMember, getMembers, getOverrides, isTypeDef

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

Method Details
- setName
  
  void setName(String name)
  
  Sets the name of the type or instance.
  
  Parameters:
  
  name - the new name
- addMember
  
  List<Member> addMember(String parentFolderUid, Tag member)
  
  Adds a member to this type, located at the specified folder path. Returns the resulting member objects (if the added member was complex, the sub members would potentially be added as well). The first element of the return will be the new member for the provided tag.
  
  Parameters:
  
  parentFolderUid - the UID of the parent to receive the new child member
  
  member - the child to add
- removeMember
  
  void removeMember(String memberUid)
  
  Removes the given member from this complex tag object. It's important to note that members can only be removed from the complex tag that defines it- not from sub classes or instances.
  
  Parameters:
  
  memberUid - the uid of the member to remove from the complex tag
  
  Throws:
  
  IllegalArgumentException - if the path refers to a member defined in a super class.