Package com.ptc.windchill.esi.rnd

Class VdbGroup

java.lang.Object
com.ptc.windchill.esi.rnd.VdbGroup
All Implemented Interfaces:
Serializable
public final class VdbGroup extends Object implements Serializable
Manages a collection of VdbElements and renderers the contents as an Info*Engine Group.

Supported API: true

Extendable: false
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addElement(Object key, VdbElement element)
    Adds a VdbElement to the collection at the location identified by key.
    com.infoengine.object.factory.Group
    asGroup()
    Renders the VdbGroup as an Info*engine Group.
    boolean
    equals(Object obj)
    Returns a true if the input object is of type VdbGroup and its name attribute has a value equal to that of this object.
    VdbElement
    getElement(Object key)
    Returns the element whose key is equal to the arrgument.
    Collection
    getElements()
    Returns the values of the elements collection.
    String
    getName()
    Gets the value of the attribute: name; The logical name of the VdbGroup.
    int
    hashCode()
    Returns the hash code associated with the name attribute.
    boolean
    isUnchanged()
    Lets the caller know if this object represents a group that holds unchanged objects in the ESI response (for e.g., "UnchangedParts").
    void
    removeElement(Object key)
    Removes an element from the elements collection if there is one with a key equal to the argument.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getName

      public String getName()
      Gets the value of the attribute: name; The logical name of the VdbGroup.

      Supported API: true
      Returns:
      String

    • isUnchanged

      public boolean isUnchanged()
      Lets the caller know if this object represents a group that holds unchanged objects in the ESI response (for e.g., "UnchangedParts").

      Supported API: true
      Returns:
      true or false, according as this object represents a group holding unchanged objects or otherwise, respectively.

    • getElement

      public VdbElement getElement(Object key)
      Returns the element whose key is equal to the arrgument. If no matching key, returns null.

      Supported API: true
      Parameters:
      key - The identifier of the object in the collection
      Returns:
      VdbElement

    • getElements

      public Collection getElements()
      Returns the values of the elements collection.

      Supported API: true
      Returns:
      Collection

    • addElement

      public void addElement(Object key, VdbElement element)
      Adds a VdbElement to the collection at the location identified by key. If there is already an element at that location, it is replaced.

      Supported API: true
      Parameters:
      key - The location to store the VdbElement.
      element - The VdbElement that is to be added to the collection.

    • removeElement

      public void removeElement(Object key)
      Removes an element from the elements collection if there is one with a key equal to the argument.

      Supported API: true
      Parameters:
      key - The key that identifies the element to be removed.

    • asGroup

      public com.infoengine.object.factory.Group asGroup()
      Renders the VdbGroup as an Info*engine Group.

      Supported API: true
      Returns:
      Group

    • equals

      public boolean equals(Object obj)
      Returns a true if the input object is of type VdbGroup and its name attribute has a value equal to that of this object. This method (along with the overridden version of hashCode()) ensures that lookups for VdbGroup objects from HashMaps behave as required by the VDB builder logic.

      Supported API: true
      Overrides:
      equals in class Object
      Parameters:
      obj - - Input object to compare with this object.

    • hashCode

      public int hashCode()
      Returns the hash code associated with the name attribute. This method (along with the overridden version of equals()) ensures that lookups for VdbGroup objects from HashMaps behave as required by the VDB builder logic.

      Supported API: true
      Overrides:
      hashCode in class Object