Package com.ptc.qualitymanagement.udi

Interface UDIAttributePopulatorService

All Known Implementing Classes:
AbstractUDIAttributePopulator, StandardFDAUDIAttributePopulator, StandardUdiSuperSet2AttributePopulator, StandardUdiSuperSetAttributePopulator
public interface UDIAttributePopulatorService
Defines the three paths used to pre-populate a UDI Super Set during creation.

Implementations will be registered as service with the selector equal to the class name of the UDI Super Set object it populates.

Supported API: true

Extendable: false

See Also:

  • Method Details

    • createUDISubmission

      UDISubmission createUDISubmission() throws WTException
      Create a properly initialized instance of the correct type of UDI Super Set object.

      Supported API: true
      Returns:
      The new instance of the UDI Super Set object
      Throws:
      WTException

    • populateFromTemplate

      Collection<UDISubmissionDetailsIfc> populateFromTemplate(UDISubmission submission, UDISubmission template) throws WTException, WTPropertyVetoException
      Populate the UDI Super Set with the default values provided by the template

      Supported API: true
      Parameters:
      submission - The UDI Super Set to populate
      template - The template containing the values to populate
      Returns:
      The detail child objects created.
      Throws:
      WTException
      WTPropertyVetoException

    • populateFromSouce

      @Deprecated Collection<UDISubmissionDetailsIfc> populateFromSouce(UDISubmission submission, Map attributes) throws WTPropertyVetoException, WTException
      Deprecated.
      API Deprecated; use populateFromSource.

      Populate the submission with attributes found in source systems.

      The default implementation will find UDI Attribute values throughout the Windchill installation based upon the submittedForReference Part.

      It is expected that customizations will extend the default implementations and override this method with calls to populate the UDI from source data.

      Supported API: true

      Parameters:
      submission -
      attributes -
      Returns:
      The detail child objects created.
      Throws:
      WTPropertyVetoException
      WTException

    • populateFromSource

      Collection<UDISubmissionDetailsIfc> populateFromSource(UDISubmission submission, Map attributes) throws WTPropertyVetoException, WTException
      Populate the UDI Super Set with attributes found in source systems.

      The default implementation will find UDI Attribute values throughout the Windchill installation based upon the Submitted For Reference Part.

      It is expected that customizations will extend the default implementations and override this method with calls to external systems where UDI data is stored.

      Supported API: true

      Parameters:
      submission - The UDI Super Set to populate
      attributes - A map of attributes defined in an excel spreadsheet which is read during import and populated on the UDI Super Set. The attribute parameter is only used during import. It is recommended to use REST API's to create UDI Super Sets instead of import.
      Returns:
      The detail child objects created.
      Throws:
      WTPropertyVetoException
      WTException

    • refreshFromSource

      void refreshFromSource(UDISubmission submission) throws WTException, WTPropertyVetoException
      Update the UDI Super Set with values from the template and source systems. This API is not supported for UDI Super Set2

      Supported API: true
      Parameters:
      submission - The UDI Super Set to refresh
      Throws:
      WTException
      WTPropertyVetoException

    • getOrderedAttributes

      List<String> getOrderedAttributes(UDISubmission submission) throws WTException
      Gets the list of ordered attributes based on the order of the human readable report.

      Supported API: true
      Parameters:
      submision - The submission containing the attributes to return
      Returns:
      An ordered list of attributes
      Throws:
      WTException