Package wt.epm.navigator.relationship

Class CADAssociatedParts

java.lang.Object
wt.epm.navigator.RelationshipContainer<wt.epm.navigator.Relationship>
wt.epm.navigator.Relationship
wt.epm.navigator.relationship.CADAssociatedParts
All Implemented Interfaces:
wt.epm.navigator.Modifier
public class CADAssociatedParts extends wt.epm.navigator.Relationship
CADAssociatedParts denotes the logical associations between an EPMDocument its associated WTParts. There are three types of associations, ACTIVE, PASSIVE and CALCULATED_BUILD (IMPLICIT), and CALCULATED_CONTENT.

Actively associated EPMDocuments can automatically propagate attribute and/or structure information to their associated WTPart whenever they are checked in. Passively associated ones cannot. Unlike active and passive, calculated links do not have a database link directly to their WTPart. They are considered associated because they reference the master of an EPMDocument that is actively or passively associated to their WTPart.

Internally, this relationship traverses different link classes depending upon type. ACTIVE traces EPMBuildRule, EPMBuildHistory and EPMBuildRuleAssociationLink while PASSIVE traces EPMDescribeLink. Starting with the seed EPMDocuments, CALCULATED_xxx traverses EPMReferenceLinks to the EPMDocuments found in their as-stored configurations. And then, it traverses the build or content links from those EPMDocuments to their associated WTParts.

This relationship begins with an EPMDocument and ends with a WTPart. It may return an EPMBuildRule, an EPMBuildHistory, an EPMBuildRuleAssociationLink, an EPMDescribeLink or an EPMReferenceLink. (CALCULATED_xxx and IMPLICIT return an EPMReferenceLink.)

The caller may apply a different set of filters to each type of association by calling filterByType(Type, Filter...).

By default, this relationship returns the latest iteration of each associated WTPart version. The caller may provide a Configuration to override the default behavior for ACTIVE and PASSIVE associations.

When navigating ACTIVE associations, in addition to traversing the build links that go directly from the EPMDocument to the WTPart, this relationship also provides an option to indirectly navigate to the WTPart by traversing the build links from any model item that belongs to the EPMDocument. See setNavigateViaModelItems(boolean)

CADAssociatedParts is the reciprocal of AssociatedCADDocs.

Supported API: true

Extendable: false

  • Method Details

    • setTypes

      public void setTypes(CADAssociatedParts.Type... types)
      Selects which types of associations to trace.

      By default, ACTIVE and then PASSIVE associations are traced.

      Parameters:
      types - - a list of association types to trace

      Supported API: true

    • getTypes

      public Set<CADAssociatedParts.Type> getTypes()
      Returns which types of associations will be traced, ACTIVE, PASSIVE, CALCULATED_BUILD (IMPLICIT) and/or CALCULATED_CONTENT.

      Supported API: true