public interface IDfVersionLabels
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getImplicitVersionLabel()
Returns the implicit version label associated with the SysObject.
|
IDfId |
getObjectId()
Returns the object ID of the SysObject.
|
java.lang.String |
getVersionLabel(int index)
Returns the version label at a given index position.
|
int |
getVersionLabelCount()
Returns a count of all the version labels associated with the SysObject.
|
boolean |
hasSymbolicVersionLabel()
Indicates whether the SysObject has symbolic labels.
|
int getVersionLabelCount() throws DfException
A SysObject's version labels are stored in the repeating attribute r_version_label. The first value in this attribute is the object's implicit version label. The remaining values are the object's symbolic version labels. This method returns a count of all values in the attribute.
For more information about implicit and symbolic version labels, refer to Server Fundamentals.
DfException
- if the server returns an errorjava.lang.String getVersionLabel(int index) throws DfException
A SysObject's version labels are stored in the repeating attribute r_version_label. The first value in this attribute is the object's implicit version label. The remaining values are the object's symbolic version labels. This method returns the version label at a given index position in the r_version_label attribute.
Index positions in repeating attributes begin at 0 and increment by
1 for each value in the attribute, up to n-1 where n
is the total number of values in the attribute. To obtain the total
number to values, use getVersionLabelCount()
.
index
- The index position of the label you want to retrieveDfException
- if the server returns an errorgetImplicitVersionLabel()
boolean hasSymbolicVersionLabel() throws DfException
This method returns true
if the object has at least
one symbolic label. For information about symbolic labels, refer
to Server Fundamentals.
true
if the SysObject has at least one
symbolic label; false
if it does notDfException
- if the server return an errorIDfId getObjectId() throws DfException
DfException
- if the server returns an errorjava.lang.String getImplicitVersionLabel() throws DfException
The implicit version label is the version label assigned by the server. It is a number that indicates the object's place on its version tree. For example, the typical implicit version label for the third version of an object is 1.3. For more information about implicit version labels, refer to Server Fundamentals.
DfException
- if the server returns an errorgetVersionLabel(int)
Copyright 1994-2023 OpenText Corporation. All rights reserved.