public interface IDfImportOperation extends IDfOperation
' Construct the operation and create a ' cast to the import operation interface. ' Dim operation As IDfOperation Dim importOperation As IDfImportOperation Set operation = clientX.getOperation("Import") Set importOperation = operation ' Establish the docbase session for the import operation to use. ' Call importOperation.setSession(session) ' Setup the file path for the file to import. ' Dim myXMLFile As IDfFile Set myXMLFile = clientX.getFile("C:\mydoc.xml") ' Add the XML file to the import operation. ' Create a cast to the import node interface. ' Dim node As IDfOperationNode Dim importNode As IDfImportNode Set node = operation.Add(myXMLFile) Set importNode = node ' Specify the XML application to use in processing this XML ' instance. Note, this could also be accomplished through ' a processing instruction in the XML content itself. ' Call node.setXMLApplicationName("MyXMLApplication") ' Execute the operation. ' If (operation.execute() = False) Then ' ' Error hanlding code goes here. Use operation.getErrors() to ' get an IDfList of operation errors back. ' End If
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. |
IDfId |
getDestinationFolderId()
Returns the docbase object Id of the destination folder for the copy operation.
|
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.
|
IDfSession |
getSession()
Returns session to be used to import new objects.
|
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 |
setDestinationFolderId(IDfId destinationFolderId)
Sets the docbase object Id for the destination folder for the copy operation.
|
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 |
setSession(IDfSession importSession)
Sets the session that will be used to create new docbase objects.
|
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, getSteps, isAborted, isEnabledPopulateWithReferences, logError, removeNode, reportError, resetErrors, setOperationMonitor, succeeded
IDfSession getSession() throws DfException
getSession
in interface IDfOperation
DfException
IDfSession
void setSession(IDfSession importSession) throws DfException
setSession
in interface IDfOperation
importSession
- session to use when importing objects.DfException
IDfSession
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
IDfId getDestinationFolderId() throws DfException
DfException
IDfFolder
void setDestinationFolderId(IDfId destinationFolderId) throws DfException
destinationFolderId
- - IDfId destination docbase folder / cabinet Id.DfException
IDfFolder
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 import operationint getMacOption()
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.
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.