public interface IDfCheckinNode extends IDfOperationNode
Modifier and Type | Method and Description |
---|---|
void |
enableOLELinksProcessing(boolean shouldProcessOLELinks)
Enables processing of OLE links.
|
int |
getCheckinVersion()
Returns an integer indicating how versioning should be handled on check in.
|
int |
getContentPageNumber()
Returns the content page number for the local content file for this object.
|
java.lang.String |
getDefaultFormat()
Returns the default repository format name for the local content file of this object.
|
java.lang.String |
getExternalVariable(java.lang.String varName)
Returns the value of an external variable.
|
java.lang.String |
getFilePath()
Returns the content file path in the local file system for this node.
|
java.lang.String |
getFormat()
Returns the repository format name for the local content file of this object.
|
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 node.
|
java.lang.String |
getMacResourceFilePath()
Returns the file path to the resource fork.
|
IDfSysObject |
getNewObject()
Returns the new IDfSysObject resulting from the check in.
|
IDfId |
getNewObjectId()
Returns the new repository object ID for the IDfSysObject resulting from the check in.
|
IDfSysObject |
getObject()
Returns the original IDfSysObject before check in.
|
IDfId |
getObjectId()
Returns the original repository object ID for the IDfSysObject before check in.
|
boolean |
getRetainLock()
Returns true if the repository 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.
|
java.lang.String |
getXMLApplicationName()
Returns the name of the XML application, if one was set, that will be applied to the document
upon import.
|
boolean |
isEnabledOLELinksProcessing()
Returns true if OLE links processing is enabled
|
void |
setCheckinVersion(int checkinVersion)
Takes an integer indicating how versioning should be handled on check in.
|
void |
setContentPageNumber(int pageNumber)
Sets the content page number for the local content file of this object.
|
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 |
setFilePath(java.lang.String newFilePath)
Sets the file path to use as the content for this object.
|
void |
setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
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 |
setMacOption(int option)
Sets the Mac behavior options for this node.
|
void |
setMacResourceFilePath(java.lang.String resourceForkFilePath)
Sets the path to the Macintosh resource fork file.
|
void |
setRetainLock(boolean retainLock)
Sets whether or not the repository object for this node should keep the lock after check in.
|
void |
setTemplate(IDfSysObject templateObject)
Sets the template to use when creating new object.
|
void |
setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that will be applied when the
node is checked in.
|
void |
setXMLApplicationName(java.lang.String appName)
Sets the XML application name for the document being imported.
|
getChildren, getEdgeProperties, getId, getOperation, getParent, getPersistentProperties, getProperties, isRoot
IDfSysObject getObject() throws DfException
DfException
IDfSysObject
IDfId getObjectId() throws DfException
DfException
IDfTypedObject.getObjectId()
IDfSysObject getNewObject() throws DfException
DfException
IDfSysObject
IDfId getNewObjectId() throws DfException
DfException
IDfTypedObject.getObjectId()
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)
java.lang.String getFilePath() throws DfException
DfException
void setFilePath(java.lang.String newFilePath) throws DfException
newFilePath
- file path in the local file system.DfException
java.lang.String getFormat() throws DfException
DfException
IDfFormat
,
IDfSysObject.getContentType()
java.lang.String getDefaultFormat() throws DfException
DfException
IDfFormat
,
IDfFormatRecognizer
,
IDfSysObject.getContentType()
void setFormat(java.lang.String formatName) throws DfException
formatName
- repository format name (for example, msw6).DfException
IDfFormat
,
IDfFormatRecognizer
,
IDfSysObject.getContentType()
int getContentPageNumber() throws DfException
DfException
IDfSysObject.setFileEx(java.lang.String, java.lang.String, int, java.lang.String)
void setContentPageNumber(int pageNumber) throws DfException
pageNumber
- content page number for the local content file of this object.DfException
IDfSysObject.setFileEx(java.lang.String, java.lang.String, int, java.lang.String)
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
IDfVersionPolicy
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
IDfVersionPolicy
void setExternalVariable(java.lang.String varName, java.lang.String value) throws DfException
varName
- The name that the variable will be available as in the XMl configuration file.value
- The value of the variable.DfException
java.lang.String getExternalVariable(java.lang.String varName) throws DfException
varName
- The name of the external variable.DfException
void enableOLELinksProcessing(boolean shouldProcessOLELinks)
shouldProcessOLELinks
- true to enable OLE links processing, false otherwise.boolean isEnabledOLELinksProcessing() throws DfException
DfException
void setTemplate(IDfSysObject templateObject)
templateObject
- The sys Object to be used as template object.void setMacResourceFilePath(java.lang.String resourceForkFilePath)
resourceForkFilePath
- The path of the Macintosh resource fork filejava.lang.String getMacResourceFilePath()
int getMacOption()
Possible values include: IGNORE_RESOURCE_FORK - No resource fork will be stored in the repository, even if resource fork file path has been specified USE_RESOURCE_FORK_IF_AVAILABLE - Resource fork will be set to the repository 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.
void setMacOption(int option)
Possible values include: IGNORE_RESOURCE_FORK - No resource fork will be stored in the repository, even if resource fork file path has been specified USE_RESOURCE_FORK_IF_AVAILABLE - Resource fork will be set to the repository 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.void setXMLApplicationName(java.lang.String appName)
appName
- The name of the XML applicationjava.lang.String getXMLApplicationName()
Copyright 1994-2023 OpenText Corporation. All rights reserved.