Package com.ptc.wvs.server.publish

Interface InterferenceInfo

All Known Implementing Classes:
InterferenceInfoImpl
public interface InterferenceInfo
A holder used to contain all the information for a specific Interference. Used when the WVS Interference Processor parses an Interference report XML file generated by the CreoView Client adapter. All information regarding a single Interference contained in these generated reports is stored in a single InterferenceInfo instance. An InterferenceInfo may also represent an existing interference persisted in the database. To determine between the two, @see isRepresentedByExistingInterference()

Supported API: true

Extendable: false

  • Method Details

    • getIsEqualsAttributes

      InterferenceInfo.ATTRIBUTE[] getIsEqualsAttributes()
      Get the isEqualAttribute array of InterferenceInfo.ATTRIBUTEs used to generate the hash code for a InterferenceInfo instance.

      Supported API: true
      Returns:
      An array of InterferenceInfo.ATTRIBUTEs.

    • getBlock

      String getBlock()
      Get the Interference XML Block that contains all information representing a single Interference.

      Supported API: true
      Returns:
      String - The single "" node as a separate XML file retrieved from an Interference report generated by the CreoView Client Adapter. Some of the getters will retrieve the same info contain in this XML string.

    • getAttributeMapPart1

      Map<String,String> getAttributeMapPart1()
      Get the attribute map for first Interference part.

      Supported API: true
      Returns:
      String - all Part 1 attributes.

    • getAttributeMapPart2

      Map<String,String> getAttributeMapPart2()
      Get the attribute map for second Interference part.

      Supported API: true
      Returns:
      Map<String, String> - all Part 2 attributes.

    • getAttributeMapParent1

      Map<String,String> getAttributeMapParent1()
      Get the attribute map for the parent of the first Interference part.

      Supported API: true
      Returns:
      Map<String, String> - all Parent 1 attributes.

    • getAttributeMapParent2

      Map<String,String> getAttributeMapParent2()
      Get the attribute map for the parent of the second Interference part.

      Supported API: true
      Returns:
      Map<String, String> - all Parent 2 attributes.

    • getAttributeMapCommon

      Map<String,String> getAttributeMapCommon()
      Get the attribute map for the Common parent of both Interfering parts.

      Supported API: true
      Returns:
      Map<String, String> - all Common Parent attributes.

    • getAttributeMapGeneric

      Map<String,String> getAttributeMapGeneric()
      Get the attribute map for the generic data of the Interference.

      Supported API: true
      Returns:
      Map<String, String> - all Generic attributes.

    • getName

      String getName()
      Get the name of the Interference.

      Supported API: true
      Returns:
      Map<String, String> - The name of the Interference.

    • getID

      String getID()
      Get the ID of the Interference.

      Supported API: true
      Returns:
      Map<String, String> - The ID of the Interference.

    • getType

      String getType()
      Get the type of Interference.

      Supported API: true
      Returns:
      String - The type of Interference.

    • getSeverity

      Double getSeverity()
      Get the severity of the Interference.

      Supported API: true
      Returns:
      Double - The severity of Interference.

    • getVolume

      Double getVolume()
      Get the volume of the Interference.

      Supported API: true
      Returns:
      Double - The volume of Interference.

    • getMinimumDistance

      Double getMinimumDistance()
      Get the minimum distance of the Interference.

      Supported API: true
      Returns:
      Double - The minimum distance of Interference.

    • getClashItem1Transform

      Transform getClashItem1Transform()
      Get ClashItem1 transform of the Interference.

      Supported API: true
      Returns:
      Transform - The ClashItem1 transform of Interference.

    • getClashItem2Transform

      Transform getClashItem2Transform()
      Get ClashItem2 transform of the Interference.

      Supported API: true
      Returns:
      Transform - The ClashItem2 transform of Interference.

    • getUserSeverity

      Integer getUserSeverity()
      Get the user severity of an Interference.

      Supported API: true
      Returns:
      Integer - The user severity of an Interference.

    • getDescription

      String getDescription()
      Get the description of the Interference.

      Supported API: true
      Returns:
      String - The description of the Interference.

    • getAssigneeReference

      WTPrincipalReference getAssigneeReference()
      Get the assignee of the Interference.

      Supported API: true
      Returns:
      WTPrincipalReference - An assignee reference.

    • getAdditionalProperties

      wt.viewmarkup.AdditionalProperties getAdditionalProperties()
      Get all the additional properties.

      Supported API: true
      Returns:
      AdditionalProperties - All properties.

    • getInterferencePartName1

      String getInterferencePartName1()
      The name of the first part that is interfering.

      Supported API: true
      Returns:
      String - The name of the part.

    • getInterferencePartName2

      String getInterferencePartName2()
      The name of the second part that is interfering.

      Supported API: true
      Returns:
      String - The name of the part.

    • getInterferencePartGroupName1

      String getInterferencePartGroupName1()
      The name of the group that the first interfering part is assigned to.

      Supported API: true
      Returns:
      String - The name of the group. If null or empty string, the part is not assigned to a group.

    • getInterferencePartGroupName2

      String getInterferencePartGroupName2()
      The name of the group that the second interfering part is assigned to.

      Supported API: true
      Returns:
      String - The name of the group. If null or empty string, the part is not assigned to a group.

    • getInterferencePartComponentInstancePath1

      String getInterferencePartComponentInstancePath1()
      Get the component instance path for the first part that is interfering, which is full path from the root component to the component that is interfering. For example, a component instance path of "/1/5/28/4" illustrates 4 levels in the structure where the first slash is root and each numeric value is a specific component.

      Supported API: true
      Returns:
      String - Path.

    • getInterferencePartComponentInstancePath2

      String getInterferencePartComponentInstancePath2()
      Get the component instance path for the second part that is interfering. which is full path from the root component to the component that is interfering. For example, a component instance path of "/1/5/45/1" illustrates 4 levels in the structure where the first slash is root and each numeric value is a specific component.

      Supported API: true
      Returns:
      String - Path.

    • getInterferencePartComponentInstanceBasePath1

      String getInterferencePartComponentInstanceBasePath1()
      Get the component instance base path for the first part that is interfering, which is the common parent instance path removed from the component instance path. For example, if the component instance path #1 is "/1/5/28/4" and the component instance path #2 is "/1/5/45/1", then the common parent instance path is "/1/5". In this case, "/28/4" will be returned.

      Supported API: true
      Returns:
      String - Base path.

    • getInterferencePartComponentInstanceBasePath2

      String getInterferencePartComponentInstanceBasePath2()
      Get the component instance base path for the second part that is interfering, which is the common parent instance path removed from the component instance path. For example, if the component instance path #1 is "/1/5/28/4" and the component instance path #2 is "/1/5/45/1", then the common parent instance path is "/1/5". In this case, "/45/1" will be returned.

      Supported API: true
      Returns:
      String - Base path.

    • getCommonParentInstancePath

      String getCommonParentInstancePath()
      Get the common parent instance path comparing the first part that is interfering and and the second part that is interfering. For example, if the component instance path #1 is "/1/5/28/4" and the component instance path #2 is "/1/5/45/1", then the common parent instance path of "/1/5" will be returned. In some cases, it maybe that the root is the only common parent of which "/" will be returned.

      Supported API: true
      Returns:
      String - Common parent instance path.

    • getInterferencePartReference1

      ObjectReference getInterferencePartReference1()
      Get the Object Reference for the first part that is interfering.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getInterferencePartReference2

      ObjectReference getInterferencePartReference2()
      Get the Object Reference for the second part that is interfering.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getCommonParentPartReference

      ObjectReference getCommonParentPartReference()
      Get the Object Reference for the common parent part for the interfering parts.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getInterferencePartMasterReference1

      ObjectReference getInterferencePartMasterReference1()
      Get the Master Object Reference for the first part that is interfering.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getInterferencePartMasterReference2

      ObjectReference getInterferencePartMasterReference2()
      Get the Master Object Reference for the second part that is interfering.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getCommonParentPartMasterReference

      ObjectReference getCommonParentPartMasterReference()
      Get the Master Object Reference for the common parent part for the interfering parts.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getParentReference2

      ObjectReference getParentReference2()
      Get the Parent Object Reference for the for the second interfering part.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • getParentReference1

      ObjectReference getParentReference1()
      Get the Parent Object Reference for the for the first interfering part.

      Supported API: true
      Returns:
      ObjectReference - An ObjectReference.

    • isRepresentedByExistingInterference

      boolean isRepresentedByExistingInterference()
      A flag that indicates if an existing Interference object already exists for a particular Interference Definition.

      Supported API: true
      Returns:
      boolean - Returns true if an existing Interference object already exists for this InterferenceInfo.

    • getExistingAssigneeReference

      WTPrincipalReference getExistingAssigneeReference()
      If an Interference object already exists, return the current assignee reference.
      Returns:
      WTPrincipalReference - A reference to a principal will be returned if an existing Interference object is represented by this InterferenceInfo and the assignee is not null.
      See Also:

    • getExistingDescription

      String getExistingDescription()
      If an Interference object already exists, return the existing description.
      Returns:
      String - The description if an existing Interference object is represented by this InterferenceInfo and the description is not null.
      See Also:

    • getExistingState

      State getExistingState()
      If an Interference object already exists, return the existing State.
      Returns:
      State - The State if an existing Interference object is represented by this InterferenceInfo and the State is not null.
      See Also: