com.sssw.cm.api
Interface EbiDocLink

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, Serializable

public interface EbiDocLink

extends EbiCmElement

Objects that implement this interface represent Links between two Documents: a Link-Parent Document and a Link-Child Document. A Document Link consists of the following pieces:

• The ID of the Parent Document to which another Document is linked;
• The ID of the Child Document that is linked to the Parent;
• The ID of the Version of the Child Document; the value of -1 means that the current Version of the Child Document is linked to the Parent, otherwise the specific ID allows for "locking in" to a specific Version of the Child; the -1 value allows for Document linking whereas the other values allow for document embedding.

Field Summary

static String

EL_DOC_LINK The element type of "Document Link"

Fields inherited from interface com.sssw.cm.api.EbiCmElement

OP_COPY, OP_MOVE, OP_REMOVE, OP_UPDATE

Method Summary

String	getChildDocumentID() Gets the ID of the Link-Child Document.
int	getChildDocumentVersionID() Gets the version ID of the Link-Child Document.
byte[]	getExtensionMeta() Gets the extension metadata associated with the Link.
String	getParentDocumentID() Gets the ID of the Link-Parent Document.
String	getUUID() Gets the UUID of the Link.
void	setChildDocumentID(String childDocID) Sets the child document ID.
void	setChildDocumentVersionID(int childID) Sets the new value for the Child Document's Version ID.
void	setExtensionMeta(byte[] extnMeta) Sets the new value for the extension metadata, (e.g.
void	setParentDocumentID(String parentDocID) Sets the parent document ID.
void	setUUID() Sets the UUID of the link.

Methods implemented from interface com.sssw.cm.api.EbiCmElement

fromXML, toXML, validateOperation

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_DOC_LINK

public static final String EL_DOC_LINK

The element type of "Document Link"

See Also:

EbiElement.getType()

Method Detail

getParentDocumentID

public String getParentDocumentID()

Gets the ID of the Link-Parent Document.

Returns:

the ID of the Link-Parent Document

getChildDocumentID

public String getChildDocumentID()

Gets the ID of the Link-Child Document.

Returns:

the ID of the Link-Child Document

getChildDocumentVersionID

public int getChildDocumentVersionID()

Gets the version ID of the Link-Child Document.

Returns:

the version ID of the Link-Child Document

getUUID

public String getUUID()

Gets the UUID of the Link.

Returns:

the UUID

getExtensionMeta

public byte[] getExtensionMeta()

Gets the extension metadata associated with the Link. The metadata may be a descriptor with additional information about the Link or an image associated with the Link.

Returns:

the extension metadata

setChildDocumentVersionID

public void setChildDocumentVersionID(int childID)

Sets the new value for the Child Document's Version ID.

Parameters:

childID - the new value for the Child Document's Version ID; pass in the value of -1 to indicate that the published Version of the Link-Child Document is to be used

setExtensionMeta

public void setExtensionMeta(byte[] extnMeta)

Sets the new value for the extension metadata, (e.g. an XML descriptor with additional information about the link or an image). EbiContentMgmtDelegate.updateDocumentLink must be called for this change to take effect.

Parameters:

extnMeta - the new value for the extension metadata

setChildDocumentID

public void setChildDocumentID(String childDocID)

Sets the child document ID.

Parameters:

childDocID -

setParentDocumentID

public void setParentDocumentID(String parentDocID)

Sets the parent document ID.

Parameters:

parentDocID -

setUUID

public void setUUID()

Sets the UUID of the link.