Package com.ptc.windchill.associativity.viz

Class AssociativeVisualizationDataControlDelegate

java.lang.Object
com.ptc.windchill.associativity.viz.VisualizationDataControlDelegate
com.ptc.windchill.associativity.viz.AssociativeVisualizationDataControlDelegate
Direct Known Subclasses:
MPMLVisualizationDataControlDelegate
public class AssociativeVisualizationDataControlDelegate extends VisualizationDataControlDelegate
Default blank implementation for providing customization hooks for controlling visualization related data.

Supported API: true

Extendable: true

  • Method Details

    • findPartRepresentablesForRepresentationJob

      public WTCollection findPartRepresentablesForRepresentationJob(WTContainerRef parentContainerReference, WVSContentHelper.IterationType iterationType)
      Controls the query to find parts valid for generating default representation in Scheduler job based on input container. This collection is further filtered out based on MPMLink criteria to generate default representation. Note: The representation would only be created for parts without any default representation. API Provides customization hook to support custom logic.

      Supported API: true

      Supported API: true
      Specified by:
      findPartRepresentablesForRepresentationJob in class VisualizationDataControlDelegate
      Parameters:
      iterationType -
      Returns:
      - Returns latest iterations of assembly parts in the given container(s).

    • getEquivalentPartsForRepresentationJob

      public WTCollection getEquivalentPartsForRepresentationJob(WTSet sourceRepresentables)
      Filters out assembly parts from input sourceRepresentables which have valid upstream equivalent. Skips self equivalent parts. Collection of valid parts are returned for generating new representation in Scheduler job. API Provides customization hook to support custom logic.

      Supported API: true

      Supported API: true
      Specified by:
      getEquivalentPartsForRepresentationJob in class VisualizationDataControlDelegate
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid assembly parts based on equivalence criteria.

    • getAllocatedPartsForRepresentationJob

      public WTCollection getAllocatedPartsForRepresentationJob(WTSet sourceRepresentables)


      Supported API: true Filters out assembly parts from input sourceRepresentables allocated to latest iteration of MPMOperation. Collection of such parts are returned for generating new representation in Scheduler job. API Provides customization hook to support custom logic.

      Supported API: true
      Specified by:
      getAllocatedPartsForRepresentationJob in class VisualizationDataControlDelegate
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid allocated assembly parts.

    • getResourcesForRepresentationJob

      public WTCollection getResourcesForRepresentationJob(WTSet sourceRepresentables)


      Supported API: true Filters out assembly MPMResources ( MPMWorkCenter invalid input: '&' MPMTooling) from input sourceRepresentables Collection of valid MPMWorkCenter invalid input: '&' MPMTooling are returned for generating new representation in Scheduler job. API Provides customization hook to support custom logic.

      Supported API: true
      Specified by:
      getResourcesForRepresentationJob in class VisualizationDataControlDelegate
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid MPMResources for processing of default representation

    • isValidForRepRepublishJob

      public boolean isValidForRepRepublishJob(Representable representable, Representation defaultRepresentation)


      Supported API: true Provides customization hook to validate and return if representable is valid for republishing of representation. Supported API: true
      Specified by:
      isValidForRepRepublishJob in class VisualizationDataControlDelegate
      Parameters:
      representable -
      defaultRepresentation -
      Returns:

    • findPartRepresentablesForQuickViewJob

      public WTCollection findPartRepresentablesForQuickViewJob(WTContainerRef parentContainerReference, WVSContentHelper.IterationType iterationType)


      Supported API: true Controls the query to find parts valid for generating/re-generating QuickView in Scheduler job based on input container. This collection is further filtered out based on MPMLink criteria to generate/re-generate QuickView API Provides customization hook to support custom logic.

      Supported API: true
      Specified by:
      findPartRepresentablesForQuickViewJob in class VisualizationDataControlDelegate
      Parameters:
      iterationType -
      Returns:
      - Returns latest iterations of assembly parts in the given container(s).

    • getEquivalentPartsForQuickViewJob

      public WTCollection getEquivalentPartsForQuickViewJob(WTSet sourceRepresentables)


      Supported API: true
      Specified by:
      getEquivalentPartsForQuickViewJob in class VisualizationDataControlDelegate
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid assembly parts based on equivalence criteria.

    • getAllocatedPartsForQuickViewJob

      public WTCollection getAllocatedPartsForQuickViewJob(WTSet sourceRepresentables)


      Supported API: true Filters out assembly parts from input sourceRepresentables allocated to latest iteration of MPMOperation. Collection of such parts are returned for generating/re-generating QuickView in Scheduler job. API Provides customization hook to support custom logic.

      Supported API: true
      Specified by:
      getAllocatedPartsForQuickViewJob in class VisualizationDataControlDelegate
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid allocated assembly parts.

    • getResourcesForQuickViewJob

      public WTCollection getResourcesForQuickViewJob(WTSet sourceRepresentables)


      Supported API: true Filters out assembly MPMResources ( MPMWorkCenter invalid input: '&' MPMTooling) from input sourceRepresentables Collection of valid MPMWorkCenter invalid input: '&' MPMTooling are returned for generating/re-generating QuickView in Scheduler job. API Provides customization hook to support custom logic.

      Supported API: true
      Specified by:
      getResourcesForQuickViewJob in class VisualizationDataControlDelegate
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid MPMResources for processing QuickView in scheduler job.

    • filterOwnerAssociationForRepresentationJob

      public WTCollection filterOwnerAssociationForRepresentationJob(WTCollection partsWithoutDefRepresentation)


      Supported API: true API filters out parts having owner association with EPMDocument. Such parts are skipped during new Representation creation. Provides customization hook if no filtering is needed. In such cases return empty collection. Supported API: true
      Specified by:
      filterOwnerAssociationForRepresentationJob in class VisualizationDataControlDelegate
      Parameters:
      partsWithoutDefRepresentation -
      Returns:

    • getDefaultRepresentationName

      public String getDefaultRepresentationName()


      Supported API: true Returns default representation name for scheduler job.

      Supported API: true
      Specified by:
      getDefaultRepresentationName in class VisualizationDataControlDelegate
      Returns:

    • getDefaultRepresentationDescription

      public String getDefaultRepresentationDescription()


      Supported API: true Returns default representation description for scheduler job.

      Supported API: true
      Specified by:
      getDefaultRepresentationDescription in class VisualizationDataControlDelegate
      Returns:

    • doValidateQuickViewPublishRules

      public boolean doValidateQuickViewPublishRules()


      Supported API: true Based on the API the generate/re-generate of QuickView will validate publish rules. If true, then publish rules would be checked else publish rules would be skipped from validation.

      Supported API: true
      Specified by:
      doValidateQuickViewPublishRules in class VisualizationDataControlDelegate
      Returns:

    • getSchedulerCriteriaTypes

      public Collection<com.ptc.core.foundation.associativity.AssociativityProperties.SchedulerCriteriaType> getSchedulerCriteriaTypes()


      Supported API: true API returns the criteria for collecting representables for scheduler jobs. Default values are EQUIVALENCE, MPMOPERATION, MPMRESOURCE EQUIVALENCE - The assembly parts having upstream equivalent would be collected MPMOPERATION - The allocated assembly parts to MPMOperation are collected. MPMRESOURCE - Collects assembly MPMResources ( MPMWorkCenter invalid input: '&' MPMTooling) for scheduled jobs.

      Supported API: true
      Specified by:
      getSchedulerCriteriaTypes in class VisualizationDataControlDelegate
      Returns: