wt.vc.wip
Class CheckoutLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.vc.wip.CheckoutLink

All Implemented Interfaces:

Externalizable, Serializable, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, DisplayIdentification

public final class CheckoutLink
extends ObjectToObjectLink
implements Externalizable

Provides the link between an original checked out object and its working copy.

Use the newCheckoutLink static factory method(s), not the CheckoutLink 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:

Serialized Form

Field Summary

static String	ORIGINAL_COPY_ROLE Label for the attribute; Association to zero or one original copy of something checked out.
static String	WORKING_COPY_ROLE Label for the attribute; Association to zero or one working copy of something checked out.

Method Summary

Workable	getOriginalCopy() Gets the object for the association that plays role: ORIGINAL_COPY_ROLE.
Workable	getWorkingCopy() Gets the object for the association that plays role: WORKING_COPY_ROLE.
void	setOriginalCopy(Workable originalCopy) Sets the object for the association that plays role: ORIGINAL_COPY_ROLE.
void	setWorkingCopy(Workable workingCopy) Sets the object for the association that plays role: WORKING_COPY_ROLE.

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

ORIGINAL_COPY_ROLE

public static final String ORIGINAL_COPY_ROLE

Label for the attribute; Association to zero or one original copy of something checked out. In the case where there is no original copy the object has not been checked out. In the case where there is one original copy the has been checked out.

Supported API: true

See Also:

CheckoutLink, Constant Field Values

WORKING_COPY_ROLE

public static final String WORKING_COPY_ROLE

Label for the attribute; Association to zero or one working copy of something checked out. In the case where there is no working copy the object has not been checked out. In the case where there is one working copy the has been checked out.

Supported API: true

See Also:

CheckoutLink, Constant Field Values

Method Detail

getOriginalCopy

public Workable getOriginalCopy()

Gets the object for the association that plays role: ORIGINAL_COPY_ROLE. Association to zero or one original copy of something checked out. In the case where there is no original copy the object has not been checked out. In the case where there is one original copy the has been checked out.

Supported API: true

Returns:

Workable

See Also:

CheckoutLink

setOriginalCopy

public void setOriginalCopy(Workable originalCopy)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: ORIGINAL_COPY_ROLE. Association to zero or one original copy of something checked out. In the case where there is no original copy the object has not been checked out. In the case where there is one original copy the has been checked out.

Supported API: true

Parameters:

originalCopy -

Throws:

WTPropertyVetoException

See Also:

CheckoutLink

getWorkingCopy

public Workable getWorkingCopy()

Gets the object for the association that plays role: WORKING_COPY_ROLE. Association to zero or one working copy of something checked out. In the case where there is no working copy the object has not been checked out. In the case where there is one working copy the has been checked out.

Supported API: true

Returns:

Workable

See Also:

CheckoutLink

setWorkingCopy

public void setWorkingCopy(Workable workingCopy)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: WORKING_COPY_ROLE. Association to zero or one working copy of something checked out. In the case where there is no working copy the object has not been checked out. In the case where there is one working copy the has been checked out.

Supported API: true

Parameters:

workingCopy -

Throws:

WTPropertyVetoException

See Also:

CheckoutLink