wt.part
Class WTPartDescribeLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.vc.struct.IteratedDescribeLink
              wt.part.WTPartDescribeLink

All Implemented Interfaces:

Externalizable, Serializable, Releasable, wt.fc.archive.Archiveable, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.part.WTPartDocumentLink

public class WTPartDescribeLink
extends IteratedDescribeLink
implements Releasable, wt.fc.archive.Archiveable, wt.part.WTPartDocumentLink, Externalizable

Associates a WTPart with a WTDocument that describes the WTPart. These documents can be standards documents or any other kind of document that evolves independently of the part.

Use the newWTPartDescribeLink static factory method(s), not the WTPartDescribeLink constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

WTPart, IteratedDescribeLink, Serialized Form

Field Summary

static String	DESCRIBED_BY_ROLE Label for the attribute.
static String	DESCRIBES_ROLE Label for the attribute.

Method Summary

static WTPartDescribeLink	newWTPartDescribeLink(WTPart describes, WTDocument describedBy) Default factory for the class.
void	setDescribedBy(Iterated describedBy) Sets the object for the association that plays role: DESCRIBED_BY_ROLE.
void	setDescribes(Iterated describes) Sets the object for the association that plays role: DESCRIBES_ROLE.

Methods inherited from class wt.vc.struct.IteratedDescribeLink

getDescribedBy, getDescribes

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DESCRIBES_ROLE

public static final String DESCRIBES_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DESCRIBED_BY_ROLE

public static final String DESCRIBED_BY_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

setDescribes

public void setDescribes(Iterated describes)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: DESCRIBES_ROLE.

Supported API: true

Overrides:

setDescribes in class IteratedDescribeLink

Parameters:

describes -

Throws:

WTPropertyVetoException

setDescribedBy

public void setDescribedBy(Iterated describedBy)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: DESCRIBED_BY_ROLE.

Supported API: true

Overrides:

setDescribedBy in class IteratedDescribeLink

Parameters:

describedBy -

Throws:

WTPropertyVetoException

newWTPartDescribeLink

public static WTPartDescribeLink newWTPartDescribeLink(WTPart describes,
                                                       WTDocument describedBy)
                                                throws WTException

Default factory for the class.

Supported API: true

Deprecated: false

Parameters:

describes -

describedBy -

Returns:

WTPartDescribeLink

Throws:

WTException