Package com.ptc.qualitymanagement.qms.dhf

Interface DHFPopulator

public interface DHFPopulator
This interface can be implemented to supported new Design History File populator types. Each populator adds specific baselineables (e.g., describe by documents, referenced documents, change requests, etc).

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPriority()
    Determines the order in populator will be run.
    void
    populateDHF(com.ptc.qualitymanagement.qms.dhf.PartRevisionInfo primarypartRevisionInfo, ManagedBaseline designHistoryFile, com.ptc.qualitymanagement.qms.dhf.DesignHistoryFileObjectsCollector dhfObjectsCollector)
    Populates a Design History File with baselineable objects.

  • Method Details

    • populateDHF

      void populateDHF(com.ptc.qualitymanagement.qms.dhf.PartRevisionInfo primarypartRevisionInfo, ManagedBaseline designHistoryFile, com.ptc.qualitymanagement.qms.dhf.DesignHistoryFileObjectsCollector dhfObjectsCollector) throws WTException
      Populates a Design History File with baselineable objects. The same populator object might be re-used to populate different design history files. If the populator has variables that store data relevant to design history file being populated, it might be necessary to reset the variable values in populateDHF().

      Supported API: true
      Parameters:
      primarypartRevisionInfo -
      designHistoryFile -
      dhfObjectsCollector - used to collect objects in populator. Call the method DesignHistoryFileObjectsCollector.tryAddBaselineable(baselineable) to include the baselineable in a set of baselineables to be added to design history file (note, the baselineable might not be included if later iteration of it was already added or if some other checks done by DesignHistoryFileObjectsCollector.tryAddBaselineable(baselineable) fail.
      Throws:
      WTException

    • getPriority

      int getPriority()
      Determines the order in populator will be run. Populators that return smaller values will run first. Values from predefined priorities in class com.ptc.qualitymanagement.qms.dhf.PopulatorPriorities can be returned in overridden method. Any other values can be used as well, however to avoid any issues, the returned value should be greater than com.ptc.qualitymanagement.qms.dhf.PopulatorPriorities.BOM (which is 0). The reason is that this is the priority for the populator com.ptc.qualitymanagement.qms.dhf.populators.PartDHFPopulator, which should run before any other poplator runs.

      Supported API: true
      Returns: