wt.clients.replication.unit
Class ReferenceItem

java.lang.Object
  wt.clients.replication.unit.ReferenceItem

All Implemented Interfaces:

Updateable

public class ReferenceItem

extends Object

implements Updateable

ReferenceItem defines a link between a PartItem and a referenced DocumentItem.

Supported API: false

Extendable: false

See Also:

PartItem, DocumentItem

Field Summary

private boolean	modified
private PartItem	referencedBy
private WTPartReferenceLink	referenceLink
private DocumentItem	references

Constructor Summary

ReferenceItem()
Create an empty ReferenceItem.

ReferenceItem(PartItem referenced_by, DocumentItem references)
Create a ReferenceItem associating the specified PartItem and DocumentItem.

ReferenceItem(PartItem referenced_by, DocumentItem references, WTPartReferenceLink reference_link)
Create a ReferenceItem associating the specified PartItem and DocumentItem using the existing ReferenceInterfaceLink.

Method Summary

void	create() Create a new WTPartReferenceLink using the current state of this object.
void	delete() Delete the referenced WTPartReferenceLink.
PartItem	getReferencedBy() Get the PartItem to be referenced by the document item
WTPartReferenceLink	getReferenceLink() Get the actual ReferenceInterfaceLink.
DocumentItem	getReferences() Return the referenced DocumentItem
boolean	isModified() Return the modified flag.
void	setModified(boolean modified) Set the modified flag.
void	setReferencedBy(PartItem referencedBy) Set the PartItem to be referenced by the document item
void	setReferenceLink(WTPartReferenceLink usage_link) Set the actual ReferenceInterfaceLink.
void	setReferences(DocumentItem references) Set the referenced DocumentItem
String	toString() Return a string for debugging.
void	update() Update the WTPartReferenceLink using the current state of this object.

Methods inherited from class java.lang.Object

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

Field Detail

referenceLink

private WTPartReferenceLink referenceLink

modified

private boolean modified

references

private DocumentItem references

referencedBy

private PartItem referencedBy

Constructor Detail

ReferenceItem

public ReferenceItem()

Create an empty ReferenceItem.

ReferenceItem

public ReferenceItem(PartItem referenced_by,
                     DocumentItem references)

Create a ReferenceItem associating the specified PartItem and DocumentItem.

Parameters:

referenced_by - the PartItem referenced

references - the DocumentItem referenced

ReferenceItem

public ReferenceItem(PartItem referenced_by,
                     DocumentItem references,
                     WTPartReferenceLink reference_link)

Create a ReferenceItem associating the specified PartItem and DocumentItem using the existing ReferenceInterfaceLink.

Parameters:

referenced_by - the PartItem referenced

references - the DocumentItem referenced

reference_link - the existing reference link

Method Detail

setModified

public void setModified(boolean modified)

Set the modified flag.

Parameters:

modified - the new value for the modified flag

isModified

public boolean isModified()

Return the modified flag.

Returns:

true if modified

create

public void create()
            throws WTException

Create a new WTPartReferenceLink using the current state of this object.

Specified by:

create in interface Updateable

Throws:

WTException

See Also:

WTException

update

public void update()
            throws WTException

Update the WTPartReferenceLink using the current state of this object.

Specified by:

update in interface Updateable

Throws:

WTException

See Also:

WTException

delete

public void delete()
            throws WTException

Delete the referenced WTPartReferenceLink.

Specified by:

delete in interface Updateable

Throws:

WTException

See Also:

WTException

setReferenceLink

public void setReferenceLink(WTPartReferenceLink usage_link)

Set the actual ReferenceInterfaceLink.

getReferenceLink

public WTPartReferenceLink getReferenceLink()

Get the actual ReferenceInterfaceLink.

Returns:

the actual ReferenceInterfaceLink

setReferences

public void setReferences(DocumentItem references)

Set the referenced DocumentItem

getReferences

public DocumentItem getReferences()

Return the referenced DocumentItem

Returns:

the referenced DocumentItem

setReferencedBy

public void setReferencedBy(PartItem referencedBy)

Set the PartItem to be referenced by the document item

Parameters:

referencedBy - the referenced PartItem

getReferencedBy

public PartItem getReferencedBy()

Get the PartItem to be referenced by the document item

Returns:

the referencedBy PartItem

toString

public String toString()

Return a string for debugging.