public interface IDfImportNode extends IDfOperationNode
Modifier and Type | Method and Description |
---|---|
void |
enableOLELinksProcessing(boolean shouldProcessOLELinks)
Enables processing of OLE links.
|
java.lang.String |
getDefaultFormat()
Returns the default repository format name for the local content file of this object.
|
IDfId |
getDestinationFolderId()
Returns the repository object ID of the destination folder for the copy operation.
|
java.lang.String |
getDocbaseObjectType()
Returns the repository object type that is used to create the new
repository object for the import node.
|
java.lang.String |
getExternalVariable(java.lang.String varName)
Returns the value of an external variable.
|
java.lang.String |
getFilePath()
Returns the canonical path to the content file on 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 Macintosh 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.
|
java.lang.String |
getNewObjectName()
Returns the object name to be used for the newly imported object.
|
IDfSysObject |
getObject()
Returns the IDfSysObject that is the subject of this operation node.
|
IDfId |
getObjectId()
Returns the repository object ID of the IDfSysObject for this node.
|
java.lang.String |
getVersionLabels()
Returns the symbolic version labels that are applied when the
node is checked in.
|
IDfId |
getXMLApplicationID()
Returns the ID of the XML application, if one was set, that is applied to the document
upon import.
|
java.lang.String |
getXMLApplicationName()
Returns the name of the XML application, if one was set, that is applied to the document
upon import.
|
boolean |
isEnabledOLELinksProcessing()
Returns true if OLE links processing is enabled
|
void |
setDestinationFolderId(IDfId destinationFolderId)
Sets the repository object ID for the destination folder for the copy operation.
|
void |
setDocbaseObjectType(java.lang.String docbaseType)
Sets the repository object type that is used to create the new
repository object for the import node.
|
void |
setExternalVariable(java.lang.String varName,
java.lang.String value)
Sets a variable that is 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 contents of 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 Macintosh behavior options for this node.
|
void |
setMacResourceFilePath(java.lang.String resourceForkFilePath)
Sets the path to the Macintosh resource fork file (DfAppleDouble format).
|
void |
setNewObjectName(java.lang.String newObjectName)
Sets the name to be used for the new copy of the object.
|
void |
setSharingParentId(IDfId parentId)
Set sharing parent id for lightweight object created by the operation.
|
void |
setTemplate(IDfSysObject templateObject)
Sets the template to use when creating a new object.
|
void |
setVersionLabels(java.lang.String newVersionLabels)
Sets the symbolic version labels that are applied when the
node is checked in.
|
void |
setXMLApplicationID(IDfId appId)
Sets the XML application ID for the document being imported.
|
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 getNewObjectName() throws DfException
DfException
void setNewObjectName(java.lang.String newObjectName) throws DfException
newObjectName
- string to use as the name of the newly copied object.DfException
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
- if a DFC error occurs, or the content file does not exist or is
not availablevoid 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
,
IDfSysObject.getContentType()
,
IDfFormatRecognizer
void setFormat(java.lang.String formatName) throws DfException
formatName
- docbase format name (e.g. msw6).DfException
IDfFormat
,
IDfSysObject.getContentType()
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
IDfId getDestinationFolderId() throws DfException
DfException
IDfFolder
void setDestinationFolderId(IDfId destinationFolderId) throws DfException
destinationFolderId
- destination repository folder / cabinet ID.DfException
IDfFolder
java.lang.String getDocbaseObjectType() throws DfException
DfException
IDfSysObject.getTypeName()
void setDocbaseObjectType(java.lang.String docbaseType) throws DfException
docbaseType
- repository object type name.DfException
IDfSysObject.getTypeName()
void setExternalVariable(java.lang.String varName, java.lang.String value) throws DfException
varName
- The name that the variable is 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 setXMLApplicationName(java.lang.String appName)
Ignore
to bypass XML processing.appName
- The name of the XML applicationjava.lang.String getXMLApplicationName()
void enableOLELinksProcessing(boolean shouldProcessOLELinks)
shouldProcessOLELinks
- true to enable OLE links processing, false otherwise.void setXMLApplicationID(IDfId appId)
Ignore
to bypass XML processing.appName
- The ID of the XML applicationIDfId getXMLApplicationID()
boolean isEnabledOLELinksProcessing() throws DfException
DfException
void setTemplate(IDfSysObject templateObject)
templateObject
- The sys Object to be used as the template object.void setMacResourceFilePath(java.lang.String resourceForkFilePath)
resourceForkFilePath
- The path of the Macintosh resource fork filejava.lang.String getMacResourceFilePath()
int getMacOption()
IGNORE_RESOURCE_FORK - No resource fork is stored in the repository, even if a resource fork file path has been specified. USE_RESOURCE_FORK_IF_AVAILABLE - The resource fork is set to the repository if supplied by the caller of the operation. REQUIRE_RESOURCE_FORK - The resource fork is required. An error is generated if resource fork is not made available. GENERATE_RESOURCE_FORK - A resource fork is generated if it is not explicitly available.
void setMacOption(int option)
IGNORE_RESOURCE_FORK - No resource fork is stored in the repository, even if the resource fork file path has been specified. USE_RESOURCE_FORK_IF_AVAILABLE - The resource fork is set to the repository if supplied by the caller of the operation REQUIRE_RESOURCE_FORK - The resource fork is required. An error is generated if the resource fork is not made available. GENERATE_RESOURCE_FORK - A resource fork is 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 setSharingParentId(IDfId parentId)
parentId
- sharing parent idCopyright 1994-2023 OpenText Corporation. All rights reserved.