public interface IDfVersionPolicy
Modifier and Type | Field and Description |
---|---|
static int |
DF_BRANCH_VERSION
Represents an object's next possible branched version.
|
static int |
DF_CANNOT_VERSION
Indicates that an object cannot be branched or saved with the same implicit version label.
|
static int |
DF_NEXT_MAJOR
Represents an object's next major implicit version label.
|
static int |
DF_NEXT_MINOR
Represents an object's next minor implicit version label.
|
static int |
DF_SAME_VERSION
Represents an object's current implicit version label.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canCheckinFromFile()
Indicates whether the object's content file can be overwritten by
an external file when the object is checked in to the repository.
|
boolean |
canVersion(int toVersion)
Tests whether an object may be saved as the next major, minor, branch,
or same version.
|
java.lang.String |
getBranchLabel()
Returns the next possible branched version label of an object.
|
int |
getDefaultCheckinVersion()
Returns the default checkin version of an object.
|
java.lang.String |
getLogComment()
Returns the log entry for an object.
|
java.lang.String |
getNextMajorLabel()
Returns the next major implicit version label for an object.
|
java.lang.String |
getNextMinorLabel()
Returns the next minor implicit version label for an object.
|
java.lang.String |
getSameLabel()
Returns the current implicit version label of an object.
|
java.lang.String |
getVersionSummary(java.lang.String separator)
Returns all implicit and symbolic version labels associated
with a SysObject.
|
boolean |
isDefaultRetainLockOnCheckin()
Indicates whether to retain the lock on an object after it is
checked into the repository.
|
static final int DF_NEXT_MAJOR
static final int DF_NEXT_MINOR
static final int DF_SAME_VERSION
static final int DF_BRANCH_VERSION
static final int DF_CANNOT_VERSION
java.lang.String getNextMajorLabel() throws DfException
A version's implicit label is the numerical version label typically assigned to the object by the server. For more information about implicit labels and versioning, refer to Server Fundamentals.
null
if the
object is immutable.DfException
- if the server returns an error.java.lang.String getNextMinorLabel() throws DfException
A version's implicit label is the numerical version label typically assigned to the object by the server. For more information about implicit labels and versioning, refer to Server Fundamentals.
null
if the
object is immutable.DfException
- if the server returns an error.java.lang.String getSameLabel() throws DfException
A version's implicit label is the numerical version label typically assigned to the object by the server. For more information about implicit labels and versioning, refer to Server Fundamentals.
DfException
- if the server returns an error.java.lang.String getBranchLabel() throws DfException
When a user creates a branched version, the server adds two more places to the version's current implicit version label. For example, if a user branches a version with the implicit label 1.2, the new branched version is assigned the label 1.2.1.0.
For more information about branching and version labels, refer to Server Fundamentals.
null
if the object is not immutable.DfException
- if the server returns an error.java.lang.String getLogComment() throws DfException
When users check in an object, they can provide some text that is entered in the log_entry attribute of the object.
DfException
- if the server returns an error.java.lang.String getVersionSummary(java.lang.String separator) throws DfException
Each SysObject has one implicit version label and may have one or more symbolic labels. For more information about an object's version labels, refer to Server Fundamentals.
separator
- the symbol used to separate the version labels in
the return value.separator
parameter.DfException
- if the server returns an error.boolean canVersion(int toVersion) throws DfException
For definitions of major, minor, and branched versions, refer to Server Fundamentals.
toVersion
- the integer representing the major, minor, branch,
or same version label that you want to test. Valid integer values and the
label test they represent are:
Integer Versioning Condition 0 Next Major Version Label (DF_NEXT_MAJOR) 1 Next Minor Version Label (DF_NEXT_MINOR) 2 Same Version Label as Object (DF_SAME_VERSION) 3 Next Branched Version Label (DF_BRANCH_VERSION)
true
if the object can be set to the version identified in
toVersion
; false
if not.DfException
- if the server returns an error.int getDefaultCheckinVersion() throws DfException
When users check in an object, this method can provide a a default version selection for the user.
For Documentum clients, the system-defined default is to check in the object as the next minor version.
Integer Versioning Condition 0 Next Major Version Label (DF_NEXT_MAJOR) 1 Next Minor Version Label (DF_NEXT_MINOR) 2 Same Version Label as Object (DF_SAME_VERSION) 3 Next Branched Version Label (DF_BRANCH_VERSION) 4 Object is Immutable (DF_CANNOT_VERSION)
DfException
- if the server returns an error.boolean isDefaultRetainLockOnCheckin() throws DfException
The checkin
method provides a boolean parameter
used for retaining a lock after an object is checked in.
If this flag is set to true
, the checkin saves the
object to the repository but does not release the lock on the object. The
save overwrites the existing object in the repository.
If the flag is set to false
, users cannot overwrite the
object in the repository and users are forced to version the object on
checkin.
The default value is false
.
true
if a lock should be retained on the object
after it is checked into the repository; false
if not.DfException
- if the server returns an error.IDfSysObject.checkin(boolean, java.lang.String)
boolean canCheckinFromFile() throws DfException
If this flag is true
, users can choose to overwrite
an object's content file with an external file when they check in the
object.
true
if a checkin from an external file is allowed;
false
if not.DfException
- if the server returns an error.Copyright 1994-2023 OpenText Corporation. All rights reserved.