public interface IDfCheckinOperation extends IDfOperation
Modifier and Type | Field and Description |
---|---|
static int |
BRANCH_VERSION |
static int |
NEXT_MAJOR |
static int |
NEXT_MINOR |
static int |
SAME_VERSION |
static int |
VERSION_NOT_SET |
GENERATE_RESOURCE_FORK, IGNORE_RESOURCE_FORK, REQUIRE_RESOURCE_FORK, RESOURCE_FORK_UNDEFINED, USE_RESOURCE_FORK_IF_AVAILABLE
Modifier and Type | Method and Description |
---|---|
IDfAcsTransferPreferences |
getAcsTransferPreferences()
Returns the
IDfAcsTransferPreferences object to be used. |
int |
getCheckinVersion()
Returns an integer indicating how versioning should be handled on check in.
|
java.lang.String |
getExternalVariable(java.lang.String varName)
Returns the value of an external variable.
|
boolean |
getKeepLocalFile()
Returns a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
int |
getMacOption()
Returns the setting for Mac handling for this operation.
|
IDfList |
getNewObjects()
Returns the list of unique new objects created as a result of this operation.
|
IDfList |
getObjects()
Returns the list of unique objects in this operation.
|
boolean |
getRetainLock()
Returns true if the docbase object for this node should keep the lock after check in.
|
java.lang.String |
getVersionLabels()
Returns the symbolic version labels that will be applied when the
node is checked in.
|
void |
setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
Sets the
IDfAcsTransferPreferences object to be used. |
void |
setCheckinVersion(int checkinVersion)
Returns an integer indicating how versioning should be handled on check in.
|
void |
setExternalVariable(java.lang.String varName,
java.lang.String value)
Sets a variable that will be available to the XML application's configuration file as an <external_variable>.
|
void |
setKeepLocalFile(boolean keepFile)
Sets a boolean value indicating whether or not the local content file
should be preserved or deleted as part of the operation.
|
void |
setLinkBase(java.lang.String linkBase)
Sets the link base to be used during import operation.
|
void |
setMacOption(int option)
Sets the Mac behavior options for this operation.
|
void |
setRetainLock(boolean retainLock)
Sets whether or not the docbase object for this node should keep the lock after check in.
|
void |
setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that will be applied when the
node is checked in.
|
abort, add, areDisabledRegistryUpdates, canUndo, disableRegistryUpdates, enablePopulateWithReferences, execute, getContext, getDescription, getErrors, getName, getNodes, getOperationMonitor, getOperationType, getProperties, getRootNodes, getSession, getSteps, isAborted, isEnabledPopulateWithReferences, logError, removeNode, reportError, resetErrors, setOperationMonitor, setSession, succeeded
static final int VERSION_NOT_SET
static final int NEXT_MAJOR
static final int NEXT_MINOR
static final int SAME_VERSION
static final int BRANCH_VERSION
java.lang.String getVersionLabels() throws DfException
DfException
IDfSysObject.getVersionLabel(int)
void setVersionLabels(java.lang.String newVersionLabels) throws DfException
newVersionLabels
- comma separated list of symbolic version labels.DfException
IDfSysObject.getVersionLabel(int)
boolean getKeepLocalFile() throws DfException
DfException
void setKeepLocalFile(boolean keepFile) throws DfException
keepFile
- if true the local content file will not be deleted as part of the operation.DfException
boolean getRetainLock() throws DfException
DfException
void setRetainLock(boolean retainLock) throws DfException
retainLock
- true to retain lock; false to release lock after check in.DfException
int getCheckinVersion() throws DfException
Possible values include: -1 VERSION_NOT_SET - No version option has been specified yet for this node. 0 NEXT_MAJOR - Object will recieve the next major version number. 1 NEXT_MINOR - Object will recieve the next minor version number. 2 SAME_VERSION - The version number for the object will remain unchanged. 3 BRANCH_VERSION - A branch version number will be used for the object.
DfException
void setCheckinVersion(int checkinVersion) throws DfException
Possible values include: -1 VERSION_NOT_SET - No version option has been specified yet for this node. 0 NEXT_MAJOR - Object will recieve the next major version number. 1 NEXT_MINOR - Object will recieve the next minor version number. 2 SAME_VERSION - The version number for the object will remain unchanged. 3 BRANCH_VERSION - A branch version number will be used for the object.
checkinVersion
- VERSION_NOT_SET, NEXT_MAJOR, NEXT_MINOR, SAME_VERSION or BRANCH_VERSION.DfException
IDfList getObjects() throws DfException
DfException
IDfSysObject
IDfList getNewObjects() throws DfException
DfException
IDfSysObject
void setExternalVariable(java.lang.String varName, java.lang.String value)
varName
- The name that the variable will be available as in the XMl configuration file.value
- The value of the variable.java.lang.String getExternalVariable(java.lang.String varName)
varName
- The name of the external variable.void setLinkBase(java.lang.String linkBase)
linkBase
- to be used during check in operationint getMacOption()
Possible values include: IGNORE_RESOURCE_FORK - No resource fork will be stored in the docbase, even if the resource fork file path has been specified USE_RESOURCE_FORK_IF_AVAILABLE - Resource fork will be set to the docbase if supplied by the caller of the operation REQUIRE_RESOURCE_FORK - Resource fork is required. An error will be generated if the resource fork is not made available. GENERATE_RESOURCE_FORK - A resource fork will be generated if it is not explicitly available.
void setMacOption(int option)
Possible values include: IGNORE_RESOURCE_FORK - No resource fork will be stored in the docbase, even if resource fork file path has been specified USE_RESOURCE_FORK_IF_AVAILABLE - Resource fork will be set to the docbase if supplied by the caller of the operation REQUIRE_RESOURCE_FORK - Resource fork is required. An error will be generated if resource fork is not made available. GENERATE_RESOURCE_FORK - A resource fork will be generated if it is not explicitly available.
option
- - possible values: IGNORE_RESOURCE_FORK, USE_RESOURCE_FORK_IF_AVAILABLE, REQUIRE_RESOURCE_FORK,
GENERATE_RESOURCE_FORK.IDfAcsTransferPreferences getAcsTransferPreferences()
IDfAcsTransferPreferences
object to be used.IDfAcsTransferPreferences
object to be usedvoid setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
IDfAcsTransferPreferences
object to be used.acsTransferPreferences
- IDfAcsTransferPreferences
object to be usedCopyright 1994-2023 OpenText Corporation. All rights reserved.