public interface IDfVersionTreeLabels
Modifier and Type | Method and Description |
---|---|
IDfId |
getChronicleId()
Returns the object ID of the version tree's root version.
|
IDfId |
getObjectIdFromVersionLabel(java.lang.String label)
Returns the object ID of the object carrying a given version label.
|
IDfVersionLabels |
getVersion(int index)
Returns the IDfVersionLabels object for a given version.
|
int |
getVersionCount()
Returns a count of the object versions in the version tree.
|
java.lang.String |
getVersionLabel(int index)
Returns the version label at a specified index.
|
int |
getVersionLabelCount(boolean includeImplicit,
boolean symbolicFirst)
Returns a count of the version labels in the object's version tree.
|
void |
invalidate()
Flushes the cached information for the IDfVersionTreeLabels object.
|
int getVersionLabelCount(boolean includeImplicit, boolean symbolicFirst) throws DfException
Every SysObject is part of a version tree. A version tree begins with the first version of the object and contains all subsequent versions. Each version on the tree has one implicit label and may also have one or more symbolic labels.
This method records the version labels for each version in an internal structure and returns a count of the version labels. Each index position in the internal structure stores the version labels for one version.
includeImplicit
- Set this to true
if you want to include the
implicit labels in the count. Set it to false
if you don't want to
include implicit labelssymbolicFirst
- Set this parameter to true
to record the
symbolic labels first followed by the implicit label in the internal
structure. Set it to false
to list the implicit version label first.DfException
- if the server returns an errorjava.lang.String getVersionLabel(int index) throws DfException
When you issue a getVersionLabelCount(boolean, boolean)
, the method returns a
count of the version labels, but also records the counted labels in an
internal structure. Each index position in the structure records the
labels for one object version on the version tree.
To obtain the version labels for a particular object version, use the
getVersionLabel
method. The index
parameter
is an index into the internal structure. The index values begins at 0.
index
- The index position of the labels you want to retrieveDfException
- if the server returns an errorint getVersionCount() throws DfException
Note that this differs from the count returned by getVersionLabelCount
because each object version may have multiple version labels.
DfException
- if the server returns an errorIDfVersionLabels getVersion(int index) throws DfException
An IDfVersionLabels object represents the version labels for one object version.
The index
parameter value is set to any number from
0 up to the total number of values returned by getVersionCount()
.
Each index value represents one object version.
index
- Identifies the object versionDfException
- if the server returns an errorIDfId getObjectIdFromVersionLabel(java.lang.String label) throws DfException
Version labels, both implicit and symbolic, are unique within a version tree. Using this method, you can obtain the object ID of the version that has a given version label.
label
- The version label associated with the object you wantDfException
- if the server returns an errorIDfId getChronicleId() throws DfException
A version tree begins with the first version of an object. This version is called the root version and its object ID is the chronicle ID for all other versions on the tree.
DfException
- if the server returns an errorvoid invalidate() throws DfException
When an IDfVersionTreeLabels object is first referenced, the system puts all the information for the tree in a cache. This method flushes that cache. The next time the object is referenced, the cache will be refreshed from the repository.
DfException
- if the server returns an errorCopyright 1994-2023 OpenText Corporation. All rights reserved.