wt.change2
Class SupportingDataFor

java.lang.Object
  extended by wt.fc.WTObject
      extended by wt.vc.ObjectToVersionLink
          extended by wt.change2.SupportingDataFor
All Implemented Interfaces:
Externalizable, Serializable, wt.change2.SupportingDataForIfc, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, DisplayIdentification

public class SupportingDataFor
extends ObjectToVersionLink
implements wt.change2.SupportingDataForIfc, Externalizable

A link between a ChangeItem and SupportingMaterial that allows interoperability between annotations/markups and change.

Use the newSupportingDataFor static factory method(s), not the SupportingDataFor 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:
ChangeItem, SupportingMaterial, Serialized Form

Field Summary
static String AFFECTED_DATA
          Label for the attribute.
static String AFFECTED_DATA_REFERENCE
          Label for the attribute.
static String SUPPORTING_MATERIAL_ROLE
          Label for the attribute.
static String VERSIONABLE_CHANGE_ITEM_ROLE
          Label for the attribute.
 
Method Summary
 Changeable2 getAffectedData()
          Gets the object for the association that plays role: AFFECTED_DATA.
 ObjectReference getAffectedDataReference()
          Gets the value of the attribute: AFFECTED_DATA_REFERENCE.
 wt.change2.SupportingMaterial getSupportingMaterial()
          Gets the object for the association that plays role: SUPPORTING_MATERIAL_ROLE.
 VersionableChangeItem getVersionableChangeItem()
          Gets the object for the association that plays role: VERSIONABLE_CHANGE_ITEM_ROLE.
 void setAffectedData(Changeable2 a_AffectedData)
          Sets the object for the association that plays role: AFFECTED_DATA.
 void setAffectedDataReference(ObjectReference a_AffectedDataReference)
          Sets the value of the attribute: AFFECTED_DATA_REFERENCE.
 void setSupportingMaterial(wt.change2.SupportingMaterial theSupportingMaterial)
          Sets the object for the association that plays role: SUPPORTING_MATERIAL_ROLE.
 void setVersionableChangeItem(VersionableChangeItem theVersionableChangeItem)
          Sets the object for the association that plays role: VERSIONABLE_CHANGE_ITEM_ROLE.
 
Methods inherited from class wt.vc.ObjectToVersionLink
duplicate, getAllObjects, getRoleObject, initialize, setRoleBObject, setRoleObject
 
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

SUPPORTING_MATERIAL_ROLE

public static final String SUPPORTING_MATERIAL_ROLE
Label for the attribute.

Supported API: true

See Also:
Constant Field Values

VERSIONABLE_CHANGE_ITEM_ROLE

public static final String VERSIONABLE_CHANGE_ITEM_ROLE
Label for the attribute.

Supported API: true

See Also:
Constant Field Values

AFFECTED_DATA

public static final String AFFECTED_DATA
Label for the attribute.

Supported API: true

See Also:
Constant Field Values

AFFECTED_DATA_REFERENCE

public static final String AFFECTED_DATA_REFERENCE
Label for the attribute.

Supported API: true

See Also:
Constant Field Values
Method Detail

getSupportingMaterial

public wt.change2.SupportingMaterial getSupportingMaterial()
Gets the object for the association that plays role: SUPPORTING_MATERIAL_ROLE.

Supported API: true

Returns:
SupportingMaterial

setSupportingMaterial

public void setSupportingMaterial(wt.change2.SupportingMaterial theSupportingMaterial)
                           throws WTPropertyVetoException
Sets the object for the association that plays role: SUPPORTING_MATERIAL_ROLE.

Supported API: true

Parameters:
theSupportingMaterial -
Throws:
WTPropertyVetoException

getVersionableChangeItem

public VersionableChangeItem getVersionableChangeItem()
Gets the object for the association that plays role: VERSIONABLE_CHANGE_ITEM_ROLE.

Supported API: true

Returns:
VersionableChangeItem

setVersionableChangeItem

public void setVersionableChangeItem(VersionableChangeItem theVersionableChangeItem)
                              throws WTPropertyVetoException
Sets the object for the association that plays role: VERSIONABLE_CHANGE_ITEM_ROLE.

Supported API: true

Parameters:
theVersionableChangeItem -
Throws:
WTPropertyVetoException

getAffectedData

public Changeable2 getAffectedData()
Gets the object for the association that plays role: AFFECTED_DATA.

Supported API: true

Returns:
Changeable2

setAffectedData

public void setAffectedData(Changeable2 a_AffectedData)
                     throws WTPropertyVetoException,
                            WTException
Sets the object for the association that plays role: AFFECTED_DATA.

Supported API: true

Parameters:
a_AffectedData -
Throws:
WTPropertyVetoException
WTException

getAffectedDataReference

public ObjectReference getAffectedDataReference()
Gets the value of the attribute: AFFECTED_DATA_REFERENCE.

Supported API: true

Returns:
ObjectReference

setAffectedDataReference

public void setAffectedDataReference(ObjectReference a_AffectedDataReference)
                              throws WTPropertyVetoException
Sets the value of the attribute: AFFECTED_DATA_REFERENCE.

Supported API: true

Parameters:
a_AffectedDataReference -
Throws:
WTPropertyVetoException