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 and IMPLICIT. Actively associated EPMDocuments automatically propagate attribute and/or structure information to their WTPart whenever they are checked in. Passively associated ones do not. Unlike active and passive, implicitly associated EPMDocuments do not have a database link directly to their WTPart. They are considered associated because they reference the master of the actively associated EPMDocument that propagates its structure information to their WTPart. Internally, this relationship traverses different link classes depending upon type. ACTIVE traces EPMBuildRule or EPMBuildHistory while PASSIVE traces EPMDescribeLink. IMPLICIT finds the one actively associated EPMDocument that propagates its structure information to the WTPart. And, finds all EPMDocuments that hava an EPMReferenceLink to its master and returns the latest iteration of each whose as-stored config contains it or an earlier iteration of the same version. This relationship begins with a WTPart and ends with an EPMDocument. And, may return an EPMBuildRule, an EPMBuildHistory, an EPMDescribeLink or no link depending upon type. IMPLICIT does not return links. 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. AssociatedCADDocs is the reciprocal of CADAssociatedParts.

Supported API: true

Extendable: false

Nested Class Summary

static class

wt.epm.navigator.relationship.AssociatedCADDocs.Type

Nested classes/interfaces inherited from class wt.epm.navigator.Relationship

wt.epm.navigator.Relationship.HasConnection, wt.epm.navigator.Relationship.JointConnection

Nested classes/interfaces inherited from class wt.epm.navigator.RelationshipContainer

wt.epm.navigator.RelationshipContainer.IncludeConnection, wt.epm.navigator.RelationshipContainer.RelationshipConnection, wt.epm.navigator.RelationshipContainer.RelationshipList

Method Summary

wt.epm.navigator.relationship.AssociatedCADDocs.Type[]	getTypes() Returns which types of associations will be traced, ACTIVE, PASSIVE, and/or IMPLICIT.
void	setTypes(wt.epm.navigator.relationship.AssociatedCADDocs.Type... types) Selects which types of associations to trace.

Methods inherited from class java.lang.Object

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

Method Detail

setTypes

public void setTypes(wt.epm.navigator.relationship.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 wt.epm.navigator.relationship.AssociatedCADDocs.Type[] getTypes()

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

Supported API: true