Package com.ptc.windchill.associativity.viz

Class VisualizationDataControlDelegate

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

Supported API: true

Extendable: true

  • Method Details

    • findPartRepresentablesForRepresentationJob

      public abstract 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
      Parameters:
      iterationType -
      sourceRepresentables -
      Returns:
      - Returns latest iterations of assembly parts in the given container(s).

    • getEquivalentPartsForRepresentationJob

      public abstract 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
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid assembly parts based on equivalence criteria.

    • getAllocatedPartsForRepresentationJob

      public abstract WTCollection getAllocatedPartsForRepresentationJob(WTSet sourceRepresentables)
      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
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid allocated assembly parts.

    • getResourcesForRepresentationJob

      public abstract WTCollection getResourcesForRepresentationJob(WTSet sourceRepresentables)
      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
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid MPMResources for processing of default representation

    • filterOwnerAssociationForRepresentationJob

      public abstract WTCollection filterOwnerAssociationForRepresentationJob(WTCollection partsWithoutDefRepresentation)
      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
      Parameters:
      partsWithoutDefRepresentation -
      Returns:

    • isValidForRepRepublishJob

      public abstract boolean isValidForRepRepublishJob(Representable representable, Representation defaultRepresentation)
      Provides customization hook to validate and return if representable is valid for republishing of representation. Supported API: true
      Parameters:
      representable -
      defaultRepresentation -
      Returns:

    • findPartRepresentablesForQuickViewJob

      public abstract WTCollection findPartRepresentablesForQuickViewJob(WTContainerRef parentContainerReference, WVSContentHelper.IterationType iterationType)
      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
      Parameters:
      iterationType -
      sourceRepresentables -
      Returns:
      - Returns latest iterations of assembly parts in the given container(s).

    • getEquivalentPartsForQuickViewJob

      public abstract WTCollection getEquivalentPartsForQuickViewJob(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/re-generating QuickView in Scheduler job. API Provides customization hook to support custom logic.

      Supported API: true
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid assembly parts based on equivalence criteria.

    • getAllocatedPartsForQuickViewJob

      public abstract WTCollection getAllocatedPartsForQuickViewJob(WTSet sourceRepresentables)
      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
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid allocated assembly parts.

    • getResourcesForQuickViewJob

      public abstract WTCollection getResourcesForQuickViewJob(WTSet sourceRepresentables)
      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
      Parameters:
      sourceRepresentables -
      Returns:
      - Returns valid MPMResources for processing QuickView in scheduler job.

    • getDefaultRepresentationName

      public abstract String getDefaultRepresentationName()
      Returns default representation name for scheduler job.

      Supported API: true
      Returns:

    • getDefaultRepresentationDescription

      public abstract String getDefaultRepresentationDescription()
      Returns default representation description for scheduler job.

      Supported API: true
      Returns:

    • doValidateQuickViewPublishRules

      public abstract boolean doValidateQuickViewPublishRules()
      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
      Returns:

    • getSchedulerCriteriaTypes

      public abstract Collection<com.ptc.core.foundation.associativity.AssociativityProperties.SchedulerCriteriaType> getSchedulerCriteriaTypes()
      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
      Returns:

    • manageQuickViewForParents

      public Collection<AssociativePath> manageQuickViewForParents(Collection<AssociativePath> parentsPaths) throws WTException
      This API will delete the quick view and representations which are generated through scheduler for all the parent parts. when structure is changed in BOM transformer after performing any action this API will handle the deletion of quick view and representations for parent parts. Supported API: true
      Parameters:
      parentsPaths -
      Throws:
      WTException