Package com.ptc.windchill.esi.map

Class ESIGroupInfo

java.lang.Object
com.ptc.windchill.esi.map.ESIGroupInfo
public final class ESIGroupInfo extends Object
Manages information about Info*Engine Groups which are to be built by the VDB builder.

Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLogicalName()
    Gets the value of the attribute: logicalName; The logical name to be used by the clients of this object when obtaining the object from the Group Information Manager.
    ESIMapInfo
    getMapInfo()
    Gets the object for the association that plays role: mapInfo.
    ESIMapInfo
    getMapInfo(String typedef)
    Gets the object for the association that plays role: mapInfo for a specified object type.
    ESIMapInfo
    getMapInfoForType(String typedef)
    Fetches the ESIMapInfo object for the input object type and returns it to the caller.
    Collection
    getMapSourceAttributes()
    Returns a collection of Strings that represent the names of the source attributes.
    Collection<String>
    getMapSourceAttributes(String typedef)
    Returns a collection of Strings that represent the names of the source attributes for a specified object type.
    String
    getPhysicalName()
    Gets the value of the attribute: physicalName; The actual name of the Info*Engine group that will be built by the VDB builder.
    String
    getReleaseClass()
    Gets the value of the attribute: releaseClass; Value to assign to a ReleaseActivity.releaseClass, when the ReleaseActivity is created.
    boolean
    isUnchanged()
    Lets the caller know if this object represents a group that holds unchanged objects in the ESI response (for e.g., "UnchangedParts").
    boolean
    usesMapId(String Id)
    Lets the caller know if the input ID is used as a map reference in any of the ESIMapInfo objects that occur as values in the HashMap in mapInfos.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • 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.

    • getLogicalName

      public String getLogicalName()
      Gets the value of the attribute: logicalName; The logical name to be used by the clients of this object when obtaining the object from the Group Information Manager.

      Supported API: true
      Returns:
      String

    • getPhysicalName

      public String getPhysicalName()
      Gets the value of the attribute: physicalName; The actual name of the Info*Engine group that will be built by the VDB builder.

      Supported API: true
      Returns:
      String

    • getReleaseClass

      public String getReleaseClass()
      Gets the value of the attribute: releaseClass; Value to assign to a ReleaseActivity.releaseClass, when the ReleaseActivity is created.

      Supported API: true
      Returns:
      String

    • getMapInfo

      public ESIMapInfo getMapInfo()
      Gets the object for the association that plays role: mapInfo.

      Supported API: true
      Returns:
      ESIMapInfo

    • getMapSourceAttributes

      public Collection getMapSourceAttributes() throws ESIMapException
      Returns a collection of Strings that represent the names of the source attributes.

      Supported API: true
      Returns:
      Collection
      Throws:
      ESIMapException

    • getMapInfo

      public ESIMapInfo getMapInfo(String typedef)
      Gets the object for the association that plays role: mapInfo for a specified object type.

      Supported API: true
      Parameters:
      typedef - The object type.
      Returns:
      ESIMapInfo

    • getMapInfoForType

      public ESIMapInfo getMapInfoForType(String typedef)
      Fetches the ESIMapInfo object for the input object type and returns it to the caller. If a matching key for the input type is not found in mapInfos, the method attempts to fetch the output for the immediate parent of the input type, by delegating the work to certain other APIs.

      Supported API: true
      Parameters:
      typedef - Input object type for which to fetch the ESIMapInfo object.
      Returns:
      ESIMapInfo object, if one could be fetched; a null, otherwise.

    • getMapSourceAttributes

      public Collection<String> getMapSourceAttributes(String typedef) throws ESIMapException
      Returns a collection of Strings that represent the names of the source attributes for a specified object type.

      Supported API: true
      Parameters:
      typedef - The object type.
      Returns:
      Collection
      Throws:
      ESIMapException

    • usesMapId

      public boolean usesMapId(String Id)
      Lets the caller know if the input ID is used as a map reference in any of the ESIMapInfo objects that occur as values in the HashMap in mapInfos.

      Supported API: true
      Parameters:
      Id - The input ID.
      Returns:
      true, if the input ID figures as a map reference in any of the ESIMapInfo objects in mapInfos; false, otherwise.