public interface IDfCheckoutOperation extends IDfOperation
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 Documentum 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 Macintosh handling for this operation.
|
IDfList |
getObjects()
Returns the list of unique objects in this operation.
|
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 |
setDownloadContent(boolean downloadContent)
If you do not want to download content, set this to
false . |
void |
setExportDescendants(boolean exportDescendants)
Causes the root object to be checked out, but not the descendants,
when a virtual document is added to the operation.
|
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 Macintosh behavior options for this operation.
|
void |
setXMLFileEncoding(java.lang.String encoding)
Allows the user to checkout 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.
|
boolean |
shouldDownloadContent()
Returns false if download content is set to
false , true otherwise. |
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
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
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 needs to be patchedvoid setXMLSchemaLocation(java.lang.String schemaLocation)
schemaLocation
- the location where the schema needs 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 - Resource fork is downloaded only if one is already available in repository. REQUIRE_RESOURCE_FORK - 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.
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 - Resource fork is downloaded only if one is already available in the repository. REQUIRE_RESOURCE_FORK - Resource fork is required. An error is generated if the resource fork is not available in the repository 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 setDownloadContent(boolean downloadContent)
false
.
The default value is true
.downloadContent
- if false the content will not be downloaded.boolean shouldDownloadContent()
false
, true
otherwise.
The default value is true
.false
if download content is set to false
, true
otherwise.void setExportDescendants(boolean exportDescendants)
true
to download descendants but not check them out.
The dafault is to download and checkout descendants.exportDescendants
- if true
, the root object will be checked out, but not
the descendants.void setXMLFileEncoding(java.lang.String encoding)
encoding
- the encoding in which the document needs to be checked out.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.