public interface IDfVirtualDocumentNode
The term virtual document tree refers to the graphic display of a virtual document's component hierarchy in the Virtual Document Manager. Each component in the tree is called a node.
Modifier and Type | Method and Description |
---|---|
boolean |
areChildrenCompound()
Indicates whether users can add, remove, or reorder the children of this
node through VDM.
|
void |
assemble(IDfSysObject object)
Creates an assembly for the node.
|
boolean |
canBeRemoved()
Indicates whether the node can be removed from its parent.
|
boolean |
canBeRestructured()
Indicates whether the node can be restructured.
|
boolean |
causesCycle()
Indicates whether the node's object ID matches that of any of its
parents in the virtual document hierarchy.
|
void |
disassemble()
Disassembles an assembly.
|
boolean |
doesSelectedVersionMatchBinding()
Indicates whether the currently displayed node object matches the
defined binding for the node.
|
IDfSysObject |
getAssemblyDocument()
Returns the document with which an assembly is associated.
|
java.lang.String |
getAssemblyDocumentBinding()
Returns the binding value between the assembly's associated document and that
document's parent document.
|
IDfVirtualDocumentNode |
getAssemblyParent()
Returns an IDfVirtualDocumentNode object for the root of the assembly
that contains this node.
|
IDfVersionTreeLabels |
getAvailableVersions()
Returns a list of the version labels for the object represented by this node.
|
com.documentum.fc.common.IDfBasicAttributes |
getBasicAttributes() |
java.lang.String |
getBinding()
Returns the version label used to resolve the binding for this node.
|
IDfVirtualDocumentNode |
getChild(int index)
Returns a given child node of this node.
|
int |
getChildCount()
Returns the number of immediate children for this node.
|
IDfId |
getChronId()
Returns the chronicle ID for the object represented by this node.
|
int |
getCopyBehavior()
Returns the copy behavior for the node.
|
boolean |
getFollowAssembly()
Returns the follow_assembly attribute setting for this node.
|
IDfId |
getId()
Returns a string that uniquely identifies this node in the
virtual document tree.
|
java.lang.String |
getLateBindingValue()
Returns the late binding value for the node.
|
java.lang.String |
getNodeToken()
Returns a string representation of the virtual document node in a
particular format.The format corresponds to the virtual document
node's position with respect to the root.
|
boolean |
getOverrideLateBindingValue()
Returns the use_node_ver_label attribute value from the containment object
associated with this node.
|
IDfVirtualDocumentNode |
getParent()
Returns the IDfVirtualDocumentNode object for the immediate parent
of this node.
|
IDfProperties |
getProperties()
Returns an interface to the DfProperties object owned by this virtual document node.
|
IDfId |
getRelationshipId()
Returns the object ID of the containment or assembly object for this node.
|
IDfSysObject |
getSelectedObject()
Returns an IDfSysObject interface for the document represented by the node.
|
java.lang.String |
getVDMNumber()
Returns the node's number in the virtual document tree.
|
IDfVirtualDocument |
getVirtualDocumentFromNode()
Returns the IDfVirtualDocument interface for the VDM window in which
the virtual document containing this node appears.
|
boolean |
isBindingBroken()
Indicates whether there is a version in the node's version tree
that matches the binding criteria.
|
boolean |
isCompound()
Indicates whether users can add to, remove, or reorder this node
in the VDM display.
|
boolean |
isFromAssembly()
Indicates whether this node was selected from an assembly.
|
boolean |
isRoot()
Indicates whether the node is the root of the virtual document tree.
|
boolean |
isStructurallyModified()
Indicates whether the node is structurally modified or not.
|
boolean |
isVirtualDocument()
Indicates whether the node is a virtual document.
|
void |
resetSelectedVersionFromBinding()
Clears any temporary object selection and resets the node's selection based
on its defined binding.
|
void |
setAssemblyDocumentBinding(java.lang.String bindingValue)
Sets the binding between an assembly's associated document and that
document's parent in the virtual document tree.
|
void |
setBinding(java.lang.String newBinding)
Defines a new version label to use to resolve the binding for this node.
|
void |
setCopyBehavior(int behavior)
Sets the copy behavior for the node.
|
void |
setFollowAssembly(boolean followAssembly)
Directs the system to use the node's assembly in the display.
|
void |
setOverrideLateBindingValue(boolean override)
Sets the use_node_ver_label attribute for the node's associated
containment object.
|
void |
setSelectedVersion(java.lang.String theVersion)
Overrides the node's binding criteria and displays the specified version.
|
IDfId getId()
IDfVirtualDocumentNode getAssemblyParent() throws DfException
getParent()
to obtain the parent node. null
if this node is not from an assemblyDfException
- if the server returns an errorgetParent()
IDfVirtualDocumentNode getParent() throws DfException
null
if this node is the root of
the virtual document tree. null
if this node is the root of the virtual document treeDfException
- if the server returns an errorgetAssemblyParent()
int getChildCount() throws DfException
DfException
- if the server returns an errorIDfVirtualDocumentNode getChild(int index) throws DfException
getChildCount()
.index
- The index number of the child you want to obtainDfException
- if the server returns an errorboolean causesCycle() throws DfException
true
, it indicates that
you are trying to add the node to itself. The server will not allow you
to save such a change. true
if the object represented by this node
occurs in this node's parent hierarchy; false
if notDfException
- if the server returns an errorboolean isRoot() throws DfException
The root of the virtual document tree is the node at the top of the tree in the VDM window.
true
if the node is the root of the virtual document tree;
false
if notDfException
- if the server returns an errorboolean isCompound() throws DfException
true
if there is any value other than
null
or empty for the a_compound_architecture attribute of the
node's immediate parent. true
if the a_compound_architecture attribute of
the node's immediate parent is not null/empty; false
if the
attribute is null/empty. This method always returns false
if the
node is selected from an assembly.DfException
- if the server returns an errorboolean areChildrenCompound() throws DfException
true
if there is any value other than
null
or empty in the a_compound_architecture attribute for
the object represented by this node. true
if the a_compound_architecture attribute for this node
is not null/empty; false
if it is null/empty. This method always
returns false
if the node is selected from an assembly.DfException
- if the server returns an errorboolean isVirtualDocument() throws DfException
true
if node is a virtual document; false
if notDfException
- if the server returns an errorboolean canBeRestructured() throws DfException
A virtual document node can be restructured if the node is either a non-compound document or if the document is a compound document and it was marked as editable in the application configuration file.
true
if the node can be restructured; false
if notDfException
- if the server returns an errorboolean canBeRemoved() throws DfException
Virtual document node can be removed.
true
if node can be removed, otherwise false
DfException
- if the server returns an errorboolean isStructurallyModified() throws DfException
Virtual document node can be removed.
true
if node can be remuved, otherwise false
DfException
- if the server returns an errorint getCopyBehavior() throws DfException
If the node is a virtual document, the copy behavior defines how its descendant children are handled when the document is copied.
Value Meaning 0 User chooses copy behavior at runtime 1 Server creates pointers to the children 2 Server makes a new copy of the children
DfException
- if the server returns an errorvoid setCopyBehavior(int behavior) throws DfException
This method is only valid for nodes that are virtual documents. To use this method, the node's parent must be checked out. The copy behavior for a virtual document defines how the server handles the document's descendants when the document is copied.
When the virtual document is copied, the server can either make new copies of the descendants or create internal pointers to the descendants.
behavior
- Set this to the integer that defines the copy behavior.
Valid values and their meanings are:
Value Meaning 0 User makes the choice between copy or pointer at runtime 1 Server creates pointers to the children 2 Server makes a new copy of the children
DfException
- if the server returns an errorIDfId getChronId() throws DfException
The chronicle ID is the object ID of the first version of an object.
DfException
- if the server returns an errorjava.lang.String getBinding() throws DfException
If the node is early-bound to the virtual document, the version label can be a symbolic or implicit value. If the node is late-bound or is the root node, this returns a null reference. If the node is selected from an assembly, this returns an implicit version label.
DfException
- if the server returns an errorvoid setBinding(java.lang.String newBinding) throws DfException
To use this method, the node's parent must be checked out.
To early bind the component to its parent, specify an implicit or
symbolic version label. To late bind the node to the parent,
specify null
in newBinding
.
You cannot use late binding for assembly nodes.
newBinding
- Set this to an implicit or symbolic version label
for early binding or to null
for late binding.DfException
- if the server returns an errorboolean isBindingBroken() throws DfException
Users can change the binding criteria through the user interface. If they do so, it might create a node with broken bindings. The term broken bindings means that there is no version of the object represented by the node that matches the binding criteria.
This method always returns false
for the root node of
the virtual document tree.
true
if no version matches the binding criteria;
false
if there is a matching version or if this is the
root nodeDfException
- if the server returns an errorboolean doesSelectedVersionMatchBinding() throws DfException
Users can change the object displayed for any given node. This method determines whether the object currently displayed for a node matches the binding defined for the node.
true
if the currently displayed object matches the defined
binding for the node; false
if not. Always returns true for the root node.DfException
- if the server returns an errorIDfSysObject getSelectedObject() throws DfException
The returned interface represents the displayed version of the document. (This can differ from the version defined by the binding criteria.)
DfException
- if the server returns an errorvoid setSelectedVersion(java.lang.String theVersion) throws DfException
Changes made to the node's display using this method are not saved to the repository. They exist only while the containing VDM window is open.
Specifying a version label that is not found in the object's version tree
results in a broken binding. The system will attempt to resolve a broken binding if
the IDfVirtualDocument.setIncludeBrokenBindings(boolean)
flag is set
to true
. If that flag is false
, the system will
not display the node.
theVersion
- Defines the version label of the version you want
to displayDfException
- if the server returns an errorvoid resetSelectedVersionFromBinding() throws DfException
Use this method to remove from the display any temporary version selected using
setSelectedVersion(java.lang.String)
and redisplay the version defined by the node's
binding criteria.
DfException
- if the server returns an errorboolean isFromAssembly() throws DfException
true
if the node is from an assembly;
false
if notDfException
- if the server returns an errorvoid setFollowAssembly(boolean followAssembly) throws DfException
To use this method, the node's parent must be checked out.
If this flag is set to true
, the system uses the
node's assembly to display the node and its descendants. The virtual
document represented by the assembly replaces the node and the assembly
components are used to select the node's children.
This change is not stored persistently for the root node.
If the node has no associated assembly or if the node is an assembly node, the follow assembly setting is ignored.
An assembly is a snap shot of a virtual document at a given point in time. For more information about assemblies and their structure, refer to Server Fundamentals.
followAssembly
- Set this to true
if you want to
display the assembly associated with a node. Set it to false
to select the descendants from the node's actual children.DfException
- if the server returns an errorboolean getFollowAssembly() throws DfException
The follow_assembly attribute determines whether the system chooses the node and its descendants for display from the node's containment objects or from an associated assembly.
For more information about the follow_assembly attribute, refer to Server Fundamentals.
true
, meaning that the node display is chosen from
an assembly; false
if not.DfException
- if the server returns an errorboolean getOverrideLateBindingValue() throws DfException
This attribute value is only important if the node is early bound to the virtual document and is itself a virtual document. In such cases, the use_node_ver_label attribute value determines whether the system uses the node's early-bound version label to select the node's late-bound children.
For more information about this attribute, refer to the Server Fundamentals.
true
if the system can use the node's early bound version
label to select its late-bound children; false
if not. The
return value is always false
for assembly nodes and the root node.DfException
- if the server returns an errorvoid setOverrideLateBindingValue(boolean override) throws DfException
This attribute's value is only important if the node is early bound to the virtual document and is itself a virtual document. In such cases, the use_node_ver_label attribute value determines whether the system uses the node's early-bound version label to select the node's late-bound children.
This method has no effect if the node is an assembly node or a root node, or is late bound to the virtual document.
override
- Set this to true
if you want to use
the node's early-bound label to resolve its late-bound children.
Set it to false
if not.DfException
- if the server returns an errorjava.lang.String getLateBindingValue() throws DfException
This method is only valid for late-bound nodes. The method searches up the node's hierarchy to find the first early-bound parent node for which use_node_ver_label is true. When it finds that node, the method returns the node's early-bound version label as this node's late-binding version label. The search on the node hierarchy begins with this node's direct parent. If that node doesn't meet the conditions, then the search progresses to the parent node's parent, and so on up the node hierachy until a late-binding value is found.
If this is the root node, the late-binding value from the IDfVirtualDocument is returned.
DfException
- if the server returns an errorIDfVersionTreeLabels getAvailableVersions() throws DfException
Every SysObject has one implicit version label and can also have one or more symbolic labels. For more information about version labels, refer to Server Fundamentals.
DfException
- if the server returns an errorIDfId getRelationshipId() throws DfException
If the node was selected from containment objects, this method returns the object ID of the containment object associated with this node. If the node was selected from an assembly, this method returns the object ID of the assembly object associated with this node.
For more information about containment and assembly objects, refer to Server Fundamentals.
DfException
- if the server returns an errorvoid assemble(IDfSysObject object) throws DfException
The node must be a virtual document.
The assembly contains all the children of the node, direct and indirect.
The assembly is associated with the document identified in
the object
paramter.
An implicit transaction is opened during this method call. You cannot call this method in a transaction. For more information about assemblies, refer to Server Fundamentals.
object
- An IDfSysObject object representing the document with which
you want to associate the assembly. This object can be the object represented
by this node or a different object.DfException
- if the server returns an errorvoid disassemble() throws DfException
This method is only valid for nodes that have an associated assembly. Disassembling an assembly removes from the repository all the assembly objects that make up the assembly.
For more information about assemblies, refer to Server Fundamentals.
DfException
- if the server returns an errorjava.lang.String getVDMNumber() throws DfException
Each node in a virtual document tree is assigned a number that indicates its position in the tree.
DfException
- if the server returns an errorIDfSysObject getAssemblyDocument() throws DfException
This method is valid only for nodes that were selected from an assembly. It returns an IDfSysObject object representing the document with which the assembly that contains this node is associated.
DfException
- if the server returns an errorjava.lang.String getAssemblyDocumentBinding() throws DfException
This method is only valid if the node is selected from an assembly.
An assembly is group of assembly objects that represent a snapshot of a virtual document. When an assembly is created, it is associated with a SysObject. If a SysObject with an associated assembly is part of a virtual document tree, you can choose to display the node and any descendants by selecting them from the assembly.
If the node is selected from an assembly, this method returns the value that binds the SysObject with which the assembly is associated to the SysObject's parent in the tree.
DfException
- if the server returns an errorgetAssemblyDocument()
,
setFollowAssembly(boolean)
void setAssemblyDocumentBinding(java.lang.String bindingValue) throws DfException
This method is only valid if the node is selected from an assembly.
An assembly is group of assembly object objects that represent a snapshot of a virtual document. When an assembly is created, it is associated with a SysObject. If a SysObject with an associated assembly is part of a virtual document tree, you can choose to display the node and any descendants by selecting them from the assembly.
If the node is selected from an assembly, this method sets the value that binds the SysObject with which the assembly is associated to the SysObject's parent in the tree.
bindingValue
- The binding valueDfException
- if the server returns an errorIDfVirtualDocument getVirtualDocumentFromNode()
Each open VDM window corresponds to an IDfVirtualDocument interface. Nodes are uniquely identified across all open VDM windows. Consequently, you can use this method to return the IDfVirtualDocument interface for the VDM window that contains this node.
java.lang.String getNodeToken() throws DfException
DfException
- if the server returns an errorIDfProperties getProperties() throws DfException
DfException
com.documentum.fc.common.IDfBasicAttributes getBasicAttributes() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.