public interface IDfVirtualDocument
Modifier and Type | Field and Description |
---|---|
static int |
ADDED_CHILD
Added child.
|
static int |
ASSEMBLY_MODIFIED
Assembly modified.
|
static int |
ASSOCIATED_ASSEMBLY
Associated assembly with assembly document.
|
static int |
COPY_BEHAVIOR_MODIFIED
Copy behavior modified.
|
static int |
DONT_REVERT_ASSEMBLIES
Flag value that can be passed to resync to change its default
behavior.
|
static int |
FOLLOW_ASSEMBLY_MODIFIED
Follow assembly modified.
|
static int |
REMOVED_ASSEMBLY
Removed assembly.
|
static int |
REMOVED_CHILD
Removed child.
|
static int |
RESYNC_ALL
Flag value for resync call to change its default behavior.
|
static int |
RESYNC_ATTRIBUTES_ONLY
Flag value that can be passed to resync to change its default
behavior.
|
static int |
RESYNC_FLAG_ON_DISCONNECT
Flag value for resync call when a session is about to
disconnect.
|
static int |
RESYNC_FLAG_ON_REFRESH
Flag value that can be passed to resync to change its default
behavior.
|
static int |
REVERT_ON_RESYNC
Flag value that can be passed to resync to change its default
behavior.
|
static int |
USE_NODE_VER_LABEL_MODIFIED
Use Node Ver Label modified.
|
static int |
VERSION_LABEL_MODIFIED
Version label modified.
|
Modifier and Type | Method and Description |
---|---|
void |
addChangeDescription(int code,
IDfId objectId,
java.lang.String contextTag,
java.lang.String description)
Records a change made to a node.
|
IDfVirtualDocumentNode |
addNode(IDfVirtualDocumentNode parentNode,
IDfVirtualDocumentNode insertAfterNode,
IDfId objectChronId,
java.lang.String binding,
boolean followAssembly,
boolean overrideLateBindingValue)
Adds a new node to the virtual document.
|
IDfVirtualDocumentNode |
addNodeToNode(IDfVirtualDocumentNode parentNode,
IDfVirtualDocumentNode insertAfterNode,
IDfVirtualDocumentNode nodeToAdd)
Adds a node to another node in the display.
|
IDfVirtualDocumentNode |
find(IDfVirtualDocumentNode startNode,
java.lang.String searchString,
java.lang.String attributeList,
int flags)
Returns the node corresponding to a specified search string.
|
IDfChangeDescription |
getChangeDescription(int index)
Returns the change description at a given index position.
|
int |
getChangeDescriptionCount()
Returns a count of the changes made in all open VDM windows.
|
IDfId |
getId()
Returns a unique identifier for the current VDM window.
|
boolean |
getIncludeBrokenBindings()
Indicates whether nodes with broken bindings are included in the display.
|
IDfVirtualDocumentNode |
getNodeFromNodeId(IDfId nodeId)
Returns the IDfVirtualDocumentNode interface for the node corresponding
to a given node ID.
|
IDfVDMNumberingScheme |
getNumberingScheme()
Returns the numbering scheme for the virtual document.
|
IDfProperties |
getProperties()
Returns an interface to the DfProperties object owned by this virtual document.
|
IDfVirtualDocumentNode |
getRootNode()
Returns the node that is the root of the virtual document.
|
IDfId |
getUniqueObjectId(int index)
Returns the object ID of the object at the specified index.
|
int |
getUniqueObjectIdCount()
Returns the count of the unique object IDs in the current virtual document.
|
void |
removeAllChangeDescriptions(java.lang.String contextTag)
Removes all the changes made in a particular VDM window.
|
void |
removeChangeDescription(IDfId objectId)
Removes the change or changes made to a node.
|
void |
removeNode(IDfVirtualDocumentNode node)
Removes a node from the virtual document.
|
void |
resetSelectedVersionsFromBinding()
Clears temporary object selections and resets all node object selections
based on their defined bindings.
|
void |
resync(IDfSession session,
IDfId objectId,
int flags)
Flushes all node information and synchronizes cached object attributes
with the repository.
|
void |
setIncludeBrokenBindings(boolean shouldIncludeBroken)
Specifies whether to display nodes with broken bindings using the CURRENT label.
|
void |
setNumberingScheme(IDfVDMNumberingScheme scheme)
Defines the numbering scheme for the virtual document display.
|
static final int ADDED_CHILD
static final int REMOVED_CHILD
static final int COPY_BEHAVIOR_MODIFIED
static final int USE_NODE_VER_LABEL_MODIFIED
static final int FOLLOW_ASSEMBLY_MODIFIED
static final int VERSION_LABEL_MODIFIED
static final int REMOVED_ASSEMBLY
static final int ASSOCIATED_ASSEMBLY
static final int ASSEMBLY_MODIFIED
static final int RESYNC_FLAG_ON_DISCONNECT
static final int RESYNC_ALL
static final int RESYNC_FLAG_ON_REFRESH
static final int REVERT_ON_RESYNC
static final int DONT_REVERT_ASSEMBLIES
static final int RESYNC_ATTRIBUTES_ONLY
IDfVirtualDocumentNode addNode(IDfVirtualDocumentNode parentNode, IDfVirtualDocumentNode insertAfterNode, IDfId objectChronId, java.lang.String binding, boolean followAssembly, boolean overrideLateBindingValue) throws DfException
parentNode
parameter must be checked out.
The followAssembly
and overrideLateBindingValue
parameters are only useful if the new component is a virtual document. The
followAssembly
parameter sets the follow_assembly attribute
of the component's associated containment object. The
overrideLateBindingValue
parameter sets the use_node_ver_label
attribute. If the new component is not a virtual document, set these parameters
to false
.
For more information about the follow_assembly and use_node_ver_label
attributes, refer to Server Fundamentals. This manual
also contains information about early and late binding for components. parentNode
- An IDfVirtualDocumentNode object that is the virtual
document to which you are adding the component.insertAfterNode
- An IDfVirtualDocumentNode object that is the sibling
that will immediately precede the new node in the virtual document's hierarchy.
If this parameter is null
, the new node is placed
as the first child of parentNode
.objectChronId
- An IDfId object that contains the chronicle ID of the
component being added.binding
- To early bind the component,
specify the version label of the version you want to bind to the virtual document. To
late bind the component to the virtual document, specify null
.followAssembly
- Set this to true
if you want to
set the follow_assembly attribute to true for the component. Otherwise,
set this parameter to false
.overrideLateBindingValue
- Set this to true
to use the
version label identified in binding
to resolve late-bound descendents of this component.DfException
- if the server returns an errorvoid removeNode(IDfVirtualDocumentNode node) throws DfException
node
- An IDfVirtualDocumentNode object for the node to be removedDfException
- if the server returns an errorIDfVirtualDocumentNode getRootNode() throws DfException
DfException
- if the server returns an errorIDfVirtualDocumentNode getNodeFromNodeId(IDfId nodeId) throws DfException
nodeId
- An IDfId object that contains the node IDDfException
- if a node matching the specified ID cannot be foundgetId()
void setIncludeBrokenBindings(boolean shouldIncludeBroken) throws DfException
shouldIncludeBroken
as
true
.
If the setIncludeBrokenBindings
flag is set to
false
, nodes with broken bindings are not displayed.
shouldIncludeBroken
- Set this to true
if you want
the server to attempt to resolve broken bindings using the CURRENT label.
Set this to false
to omit nodes with broken bindings.DfException
- if the server returns an errorboolean getIncludeBrokenBindings() throws DfException
setIncludeBrokenBindings(boolean)
flag is set to true
,
VDM displays nodes with broken bindings using the CURRENT version of the node. true
if nodes with broken bindings are being resolved
using the CURRENT label; false
if broken nodes are being omittedDfException
- if the server returns an errorvoid resetSelectedVersionsFromBinding() throws DfException
IDfVirtualDocumentNode.setSelectedVersion(java.lang.String)
. The temporary
node selections are cleared and the nodes are reset based on
their defined bindings. DfException
- if the server returns an errorvoid resync(IDfSession session, IDfId objectId, int flags) throws DfException
Calling resync
for a node throws away all children
of the node. After a resync
, node IDs issued for the
node and its children
prior to the call are no longer valid. You must re-execute
IDfVirtualDocumentNode.getId()
to obtain new node
IDs for the children.
session
- An IDfSession object for the current sessionobjectId
- An IdfId object containing the object ID of the node
you want to resynchronize.flags
- Optional flags that can be passed to change the default
behavior of resync. You should pass 0
to get the
default behavior. By default, if the object is checked out, calling
resync does not clear the VDM cache. This behavior can be
altered by passing either REVERT_ON_RESYNC
or
DONT_REVERT_ASSEMBLIES
as the flag value.DfException
- if the server returns an errorREVERT_ON_RESYNC
,
DONT_REVERT_ASSEMBLIES
IDfId getId()
int getUniqueObjectIdCount() throws DfException
DfException
- if the server returns an errorIDfId getUniqueObjectId(int index) throws DfException
getUniqueObjectIdCount()
, the method returns
the number of unique object IDs in the virtual document. It also stores
the object IDs in an internal structure. By providing the index into that
structure as a parameter in getUniqueObjectId
, you can
obtain the object ID for that object. Index values begin at 0.
For example:
int count=virtualDocument.getUniqueObjectIdCount(); for(int index=0; index < count; i++) { IDfId id = virtualDocument.getUniqueObjectId(index); // use ID... }
index
- The index value that identifies the object whose ID you
want to obtainDfException
- if the server returns an errorvoid addChangeDescription(int code, IDfId objectId, java.lang.String contextTag, java.lang.String description) throws DfException
code
- Set this to the change description code corresponding to
the change description string.objectId
- An IDfId object that contains the object ID of the object
affected by the change. (Each node represents a repository object that is
a component of the virtual document.)contextTag
- Set this to the virtual document tree identifierdescription
- The text description of the changeDfException
- if the server returns an errorvoid removeChangeDescription(IDfId objectId) throws DfException
objectId
- An IDfId object for the object whose changes
you want to removeDfException
- if the server returns an errorvoid removeAllChangeDescriptions(java.lang.String contextTag) throws DfException
contextTag
parameter is specified as an empty string,
the method removes all the changes made for all open VDM windows. contextTag
- Identifies the VDM window. If this is an empty string,
all the changes are removed for all open VDM windows.DfException
- if the server returns an errorint getChangeDescriptionCount() throws DfException
DfException
- if the server returns an errorIDfChangeDescription getChangeDescription(int index) throws DfException
index
parameter for this method
is derived from the count returned by getChangeDescriptionCount()
.
Index positions begin at 0 and increment by 1 up to the total count returned by
getChangeDescriptionCount
. index
- Identifies the index position of the change descriptionDfException
- if the server returns an errorvoid setNumberingScheme(IDfVDMNumberingScheme scheme) throws DfException
scheme
- An IDfVDMNumberingScheme object for the desired numbering schemeDfException
- if the server returns an errorIDfVirtualDocumentNode find(IDfVirtualDocumentNode startNode, java.lang.String searchString, java.lang.String attributeList, int flags) throws DfException
startNode
. The attributes to
be searched are specified in attributeList
. The search
string is defined in searchString
. startNode
- An IDfVirtualDocument object representing the node
at which the search is startedsearchString
- Identifies the string for which you are searchingattributeList
- Set this to a comma-separated list of attributes on
which to conduct the searchflags
- Defines the settings for find. Pass 0 to obtain the default settings. The
default settings are that the search is case insensitive and is performed on
the attributes in the order in which they are listed in attributeList
.
To obtain non-default settings, you must customize the implementation of this
method.DfException
- if the server returns an errorIDfVDMNumberingScheme getNumberingScheme() throws DfException
DfException
- if the server returns an errorIDfVirtualDocumentNode addNodeToNode(IDfVirtualDocumentNode parentNode, IDfVirtualDocumentNode insertAfterNode, IDfVirtualDocumentNode nodeToAdd) throws DfException
parentNode
- An IDfVirtualDocumentNode object identifying the node to
which you are adding the new nodeinsertAfterNode
- An IDfVirtualDocumentNode object identifying the node
that will immediately precede the new node in the displaynodeToAdd
- An IDfVirtualDocumentNode object identifying the node you
are addingDfException
- if the server returns an errorIDfProperties getProperties()
Copyright 1994-2023 OpenText Corporation. All rights reserved.