Package wt.epm.navigator.relationship

Class AssociatedCADDocs

java.lang.Object

wt.epm.navigator.RelationshipContainer<wt.epm.navigator.Relationship>

wt.epm.navigator.Relationship

wt.epm.navigator.relationship.AssociatedCADDocs

All Implemented Interfaces:

wt.epm.navigator.Modifier

public class AssociatedCADDocs
extends wt.epm.navigator.Relationship

AssociatedCADDocs denotes the logical associations between a WTPart and its associated EPMDocuments. There are three types of associations, ACTIVE, PASSIVE, 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 associations 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. CALCULATED_xxx traverses build links or describe links to the associated EPMDocuments and then traverses the EPMReferenceLinks from their masters to the EPMDocuments that reference them. And, it returns the latest iteration of each whose as-stored configuration contains the associated EPMDocument or an earlier iteration of the same version.

This relationship begins with a WTPart and ends with an EPMDocument. It may return an EPMBuildRule, an EPMBuildHistory, an EPMBuildRuleAssociationLink, an EPMDescribeLink or an EPMReferenceLink. (CALCULATED_xxx returns 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 EPMDocument 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 WTPart to the EPMDocument, this relationship also provides an option to indirectly navigate to the EPMDocument by traversing the build links that go to any model item that belongs to the EPMDocument. See setNavigateViaModelItems(boolean)

AssociatedCADDocs is the reciprocal of CADAssociatedParts.

Supported API: true

Extendable: false

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AssociatedCADDocs.Type	This relationship navigates from a WTPart to a CAD document.

Method Summary

Modifier and Type	Method	Description
Set<AssociatedCADDocs.Type>	getTypes()	Returns which types of associations will be traced, ACTIVE, PASSIVE, CALCULATED_BUILD (IMPLICIT) and/or CALCULATED_CONTENT.
void	setTypes(AssociatedCADDocs.Type... types)	Selects which types of associations to trace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

setTypes

public void setTypes(AssociatedCADDocs.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<AssociatedCADDocs.Type> getTypes()

Returns which types of associations will be traced, ACTIVE, PASSIVE, CALCULATED_BUILD (IMPLICIT) and/or CALCULATED_CONTENT.

Supported API: true