Package com.ptc.windchill.esi.delegate

Interface ESIDifferenceManagementDelegate

All Known Implementing Classes:
ESIPartDifferenceManagementDelegateImpl
public interface ESIDifferenceManagementDelegate
Represents part information identified for Part Diff logic calculation by the ESIWTPartRender and ESIPartUtility.

Supported API: true

Extendable: true

  • Method Details

    • getPartIteration

      Collection<ESIPartMasterIteration> getPartIteration(Collection<? extends WTPartMaster> partMasters, NavigationCriteria navigationCriteria) throws WTException
      Returns a collection of ESIPartMasterIteration objects given a collection of part masters. The method uses the ConfigSpec instance(s) associated with the input NavigationCriteria object to fetch the part iteration for a given master.

      Supported API: true
      Parameters:
      partMasters - - Collection of part masters for which to fetch ESIPartMasterIteration objects.
      navigationCriteria - - Input NavigationCriteria object to use for fetching the part iteration for a given master.
      Returns:
      Collection of ESIPartMasterIteration objects.
      Throws:
      WTException

    • getPartIteration

      ESIPartMasterIteration getPartIteration(WTPartMaster partMaster, NavigationCriteria navigationCriteria) throws WTException
      Returns an ESIPartMasterIteration objects given a part masters. The method uses the ConfigSpec instance(s) associated with the input NavigationCriteria object to fetch the part iteration for a given master.

      Supported API: true
      Parameters:
      partMaster - - The part masters for which to fetch ESIPartMasterIteration objects.
      navigationCriteria - - Input NavigationCriteria object to use for fetching the part iteration for a given master.
      Returns:
      An ESIPartMasterIteration objects.
      Throws:
      WTException

    • getPrevPublishedIteration

      WTPart getPrevPublishedIteration(WTPart part, Collection<ESITargetAssociation> prevTgtAssociations) throws WTException
      Returns the previously published iteration for the input part using the input collection of target associations. The returned iteration could even be identical to the input part iteration, depending on what was passed in for prevTgtAssociations.

      Supported API: true
      Parameters:
      part - - Input part for which to fetch the previously published iteration.
      prevTgtAssociations - - Collection of ESITargetAssociation objects for previously published iterations, all of which are associated to a given distribution target.
      Returns:
      Part iteration that was previously published to the given distribution target, if such an iteration exists; null, otherwise.
      Throws:
      WTException - - if any of the invoked methods throws this exception.

    • getAllSoftAttributes

      wt.iba.value.litevalue.AbstractValueView[] getAllSoftAttributes(wt.iba.value.IBAHolder ibaHolder)
      Deprecated.

      Supported API: true
      Returns the soft attributes associated to the input object as an array of AbstractValueView objects.
      Parameters:
      ibaHolder - - Input IBAHolder object for which to fetch the associated soft attributes.
      Returns:
      Array of AbstractValueView objects that represent the soft attributes associated to the input object; a null, if an error was encountered while fetching the soft attributes.

    • getSoftAttribute

      String getSoftAttribute(wt.iba.value.litevalue.AbstractValueView[] values, String attributeName)
      Deprecated.

      Supported API: true
      Returns the value of the soft attribute having the input name from the input array of AbstractValueView objects.
      Parameters:
      values - - Input array of AbstractValueView objects.
      attributeName - - Name of the soft attribute for which to return the value.
      Returns:
      String Value of the soft attribute having the input name; a null, if the value could not be fetched from the input array.

    • getSoftAttribute

      String getSoftAttribute(wt.iba.value.IBAHolder ibaHolder, String attributeName)
      Deprecated.

      Supported API: true
      Returns the value of the soft attribute having the input name for the input object. Delegates the actual work to certain lower level APIs.
      Parameters:
      ibaHolder - - Input object for which to fetch the soft attribute value.
      attributeName - - Name of the soft attribute associated to the input object for which to return the value.
      Returns:
      String Value of the soft attribute having the input name.

    • hasPartChanged

      boolean hasPartChanged(WTPart currPart, WTPart prevPart, ESITargetAssociation tgtAssoc, ESIEffectivityHandler effHandler, NCServerHolder ncServerHolder, boolean ignoreEnterpriseDataChanged) throws WTException
      Lets the caller know if the currently published part iteration is different from a previously published iteration of the same part for a given distribution target. The method first checks if the version of the part has changed, and if not, checks if the effectivity on the part has changed and if not, then check if enterprise data associated with part has changed since it was last released.

      Supported API: true
      Parameters:
      currPart - - Currently published part iteration.
      prevPart - - Previously published part iteration.
      tgtAssoc - - ESITargetAssociation for the currently published part iteration.
      effHandler - - ESIEffectivityHandler instance, used for determining if the effectivity on the currently published part iteration is already released to the distribution target in the input target association.
      ncServerHolder - The ncServerHolder holds navigation criteria
      ignoreEnterpriseDataChanged - - Indicates if Enterprise Data changes need to be considered or not.
      vdbBuilder -
      Returns:
      boolean true, if the currently published part iteration is different from the previously published one; false, otherwise.
      Throws:
      ESIRendererException
      WTException

    • findAddedParts

      Collection<ESITargetAssociation> findAddedParts(Collection<ESITargetAssociation> previousParts, Collection<ESITargetAssociation> currentParts)
      Fetches the collection of ESITargetAssociations of part which is being published for the first time.

      Supported API: true
      Parameters:
      previousParts - - Collection of ESITargetAssociations of previously published parts.
      currentParts - - Collection of ESITargetAssociations of part which are being published as part of current transaction.
      Returns:
      Collection of ESITargetAssociations.

    • getTargets

      Collection<ESITarget> getTargets(Collection<ESITargetAssociation> targetAssociations, WTPart part)
      Fetches the collection of ESITargets of part from respective target associations.

      Supported API: true
      Parameters:
      targetAssociations - - Collection of ESITargetAssociations
      part - - WTPart being published.
      Returns:
      Collection of ESITargets.

    • getTargets

      Collection<ESITarget> getTargets(Collection<ESITargetAssociation> targetAssns)
      Fetches the ESITarget objects from the input collection of target associations, stores them in a HashSet and returns it to the caller.

      Supported API: true
      Parameters:
      targetAssns - - Input collection of ESITargetAssociations.
      Returns:
      Collection Output collection of ESITarget objects.

    • getAddedAlternateTargetAssociations

      Collection<ESITargetAssociation> getAddedAlternateTargetAssociations(Collection<ESITargetAssociation> partTargetAssoc, Collection<WTPart> alternates)
      Fetches the ESITarget association objects from the input collection of target associations, identifies the alternate part target association from the input collection of parts and returns it to the caller.

      Supported API: true
      Parameters:
      partTargetAssoc - - Input collection of ESITargetAssociations.
      alternates - - Input collection of alternate parts.
      Returns:
      Collection of ESITargetAssociations.

    • getDeletedAltrnateParts

      Collection<WTPart> getDeletedAltrnateParts(Collection<ESITargetAssociation> curPartAssoc, Collection<WTPart> alts)
      Fetches the deleted alternate part objects from the input collection of target associations and alternate parts.

      Supported API: true
      Parameters:
      curPartAssoc - - Input collection of ESITargetAssociations.
      alts - - Input collection of alternate parts.
      Returns:
      Collection of WTPart.

    • findChangedParts

      Collection<ESITargetAssociation>[] findChangedParts(Collection<ESITargetAssociation> currAssoc, Collection<ESITargetAssociation> previousAssoc, VdbBuilder builder, ESIEffectivityHandler effHandler) throws WTException
      Identifies and fetches the target association objects of changed parts from the input collection of current target associations and previous target associations.

      Supported API: true
      Parameters:
      currAssoc - - Input collection ESITargetAssociations for part currently being published.
      previousAssoc - - Input collection of ESITargetAssociations for previously published parts.
      Returns:
      Collection of ESITargetAssociations.
      Throws:
      WTException

    • findChangedParts

      default Collection<ESITargetAssociation>[] findChangedParts(Collection<ESITargetAssociation> currAssoc, Collection<ESITargetAssociation> previousAssoc, VdbBuilder builder, ESIEffectivityHandler effHandler, String groupName) throws WTException
      Identifies and fetches the target association objects of changed parts from the input collection of current target associations and previous target associations. GroupName is the name against which this findChangedPart is being invoked.

      Supported API: true
      Parameters:
      currAssoc - - Input collection ESITargetAssociations for part currently being published.
      previousAssoc - - Input collection of ESITargetAssociations for previously published parts.
      Returns:
      Collection of ESITargetAssociations.
      Throws:
      WTException

    • getPartToPreviousExportedIterationMap

      Map[] getPartToPreviousExportedIterationMap(Collection<WTPart> parts, Collection<ESITargetAssociation> previousTargetAssoc)
      Returns an array of Maps. Each key in a Map is a part in the input collection and the value is the corresponding previously published iteration. The Maps at indices 0, 2 and 3 in the output array hold the added, changed and unchanged parts respectively as keys.

      Supported API: true
      Parameters:
      parts - - Collection parts whose previous exported iterations need to be identified from the target association collection "previousTargetAssoc".
      previousTargetAssoc - - Target associations corresponding to the previous exported iterations of the parts in the input "parts" collection.
      Returns:
      An array of Maps. The Maps at indices 0, 2 and 3 hold the added, changed and unchanged parts respectively as keys and the corresponding previously published iterations as values. The Map at index 1 will be empty.

    • processQueryResultsOfPartIterations

      void processQueryResultsOfPartIterations(QueryResult qr, Collection<ESIPartMasterIteration> esipmis)
      Processes the input query results and populates the input collections as appropriate. See the argument descriptions for more information.

      Supported API: true
      Parameters:
      qr - Input query results to process.
      esipmis - Collection to be populated with ESIPartMasterIteration objects.

    • getPartMasterWithClasses

      Map<Class,wt.fc.ObjectVector> getPartMasterWithClasses(Collection<? extends WTPartMaster> partMasters)
      Deprecated.
      Returns the Map containing Class for a PartMsater as key and ObjectVector of part masters object that are of the class type as value. API separates part masters of different class types to resolve iteration based on respective class type. Supported API: true
      Parameters:
      partMasters - - The input part master collection.
      Returns:
      - The Map containing Class for a PartMaster as key and ObjectVector of part masters object that are of the class type as value.

    • isIterationInSameViewVariations

      boolean isIterationInSameViewVariations(ViewManageable newPartIteration, ViewManageable oldPartIteration)
      Check if the input part iterations are from the same view and have the same values for variation1 (i.e. BOM Usage) and variation2 (i.e BOM Alternate).


      Supported API: true
      Parameters:
      newPartIteration - - The new iteration of part to be compared.
      oldPartIteration - - The old iteration of part with which new iteration needs to be compared.
      Returns:
      - true, if the input part iterations are from the same view and have the same variation1 and variation2 values; otherwise false.

    • getSoftAttribute

      String getSoftAttribute(Object ibaHolder, String attributeName)
      Returns the value of the soft attribute having the input name for the input object. Delegates the actual work to certain lower level APIs.

      Supported API: true
      Parameters:
      ibaHolder - - Input object for which to fetch the soft attribute value.
      attributeName - - Name of the soft attribute associated to the input object for which to return the value.
      Returns:
      String Value of the soft attribute having the input name.