public interface IDfExportOperation extends IDfOperation
Modifier and Type | Field and Description |
---|---|
static int |
DONT_RECORD_IN_REGISTRY |
static int |
RECORD_AS_LOCAL_FILE_IN_REGISTRY |
static int |
RECORD_AS_VIEWED_FILE_IN_REGISTRY |
GENERATE_RESOURCE_FORK, IGNORE_RESOURCE_FORK, REQUIRE_RESOURCE_FORK, RESOURCE_FORK_UNDEFINED, USE_RESOURCE_FORK_IF_AVAILABLE
Modifier and Type | Method and Description |
---|---|
void |
enableManageApplicationSupportDocuments(boolean shouldManageAppSuppDocs)
If you do not want to manage any of the documents in the Application Support Documents
set this to false.
|
IDfAcsTransferPreferences |
getAcsTransferPreferences()
Returns the
IDfAcsTransferPreferences object to be used. |
java.lang.String |
getDefaultDestinationDirectory()
Returns the default file system directory path that is the
output location for the outbound content files.
|
java.lang.String |
getDestinationDirectory()
Returns the file system directory path that is the default
output location for the outbound content files.
|
int |
getMacOption()
Returns the setting for Mac handling for this operation.
|
IDfList |
getObjects()
Returns the list of unique objects in this operation.
|
int |
getRecordInRegistry()
Returns an integer that indicates if this node should be
recorded in the client registry.
|
void |
setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
Sets the
IDfAcsTransferPreferences object to be used. |
void |
setBaseFolder(java.lang.String cabinetFolderPath,
java.lang.String linkBase)
Normally, when an XML virtual document is exported without its descendants, external references
are patched as DRLs.
|
void |
setDestinationDirectory(java.lang.String dirPath)
Sets the file system directory path that is the default
output location for the outbound content files.
|
void |
setIncludeDCTMAttrsInXML(boolean includeDCTMAttrsInXML)
Determines whether or not dctm attributes(dctm:obj_id, dctm:status and dctm:version_label)
are added to the chunk points of the XML stream.
|
void |
setIncludeExternalReferences(boolean includeExternalRefs)
If you do not want any external references(for example, images) downloaded, set
this to false.
|
void |
setMacOption(int option)
Sets the Mac behavior options for this operation.
|
void |
setRecordInRegistry(int registryRecordingPreference)
Sets an integer that indicates if this node should be
recorded in the client registry.
|
void |
setXMLFileEncoding(java.lang.String encoding)
Allows the user to export XML files in a particular encoding.
|
void |
setXMLSchemaLocation(java.lang.String schemaLocation)
Allows the user to specify the schema location to patch in the xml content.
|
void |
setXMLSystemId(java.lang.String dtdPath)
Allows the user to specify the dtd path to patch in the xml content.
|
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 DONT_RECORD_IN_REGISTRY
static final int RECORD_AS_VIEWED_FILE_IN_REGISTRY
static final int RECORD_AS_LOCAL_FILE_IN_REGISTRY
java.lang.String getDestinationDirectory() throws DfException
DfException
void setDestinationDirectory(java.lang.String dirPath) throws DfException
dirPath
- file system directory path.DfException
java.lang.String getDefaultDestinationDirectory() throws DfException
DfException
int getRecordInRegistry() throws DfException
0 DONT_RECORD_IN_REGISTRY - just export the content file. 1 RECORD_AS_VIEWED_FILE_IN_REGISTRY - record the object as a Viewed file. 2 RECORD_AS_LOCAL_FILE_IN_REGISTRY - record the object as a Local copy item.
DfException
void setRecordInRegistry(int registryRecordingPreference) throws DfException
0 DONT_RECORD_IN_REGISTRY - just export the content file. 1 RECORD_AS_VIEWED_FILE_IN_REGISTRY - record the object as a Viewed file. 2 RECORD_AS_LOCAL_FILE_IN_REGISTRY - record the object as a Local copy item.
registryRecordingPreference
- intteger indicating the registry recording setting.DfException
IDfList getObjects() throws DfException
DfException
IDfSysObject
void setIncludeExternalReferences(boolean includeExternalRefs)
includeExternalRefs
- if false
, the external references will not be downloaded.void enableManageApplicationSupportDocuments(boolean shouldManageAppSuppDocs)
true
.shouldManageAppSuppDocs
- if false
, the documents in Application Support Documents folder
will not be downloaded.setXMLSystemId(java.lang.String)
void setBaseFolder(java.lang.String cabinetFolderPath, java.lang.String linkBase)
cabinetFolderPath
- the cabinet/folder path where the external references need to be patchedlinkBase
- the linkbase to be prepended to the cabinet/folder path.void setXMLSystemId(java.lang.String dtdPath)
dtdPath
- the path where the dtd need to be patchedvoid setXMLSchemaLocation(java.lang.String schemaLocation)
schemaLocation
- the location where the schema need to be patchedint getMacOption()
IGNORE_RESOURCE_FORK - No resource fork is output, even if the resource fork is present in the repository. USE_RESOURCE_FORK_IF_AVAILABLE - The resource fork is downloaded only if one is already available in repository. REQUIRE_RESOURCE_FORK - The resource fork is required. An error is generated if resource fork is not available in the repository. 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 output, even if the resource fork is present in the repository. USE_RESOURCE_FORK_IF_AVAILABLE - The resource fork is downloaded only if one is already available in repository. REQUIRE_RESOURCE_FORK - The resource fork is required. An error is generated if the resource fork is not available in the repository. 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 setIncludeDCTMAttrsInXML(boolean includeDCTMAttrsInXML)
true
to add dctm attributes.
The default value is false
.includeDCTMAttrsInXML
- if true
, the external references are not downloaded.void setXMLFileEncoding(java.lang.String encoding)
encoding
- the encoding in which the document needs to be exported.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.