public interface IDfCheckoutNode extends IDfOperationNode
Modifier and Type | Method and Description |
---|---|
IDfEnumeration |
getAcsRequests()
Returns an
IDfEnumeration object with a list of IDfAcsRequest objects. |
IDfAcsTransferPreferences |
getAcsTransferPreferences()
Returns the
IDfAcsTransferPreferences object to be used. |
java.lang.String |
getDefaultFormat()
Returns the default content file format for this object in the repository.
|
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.
|
int |
getMacOption()
Returns the setting for Macintosh handling for this node.
|
java.lang.String |
getMacResourceFilePath()
Returns the file path to the resource fork for this node.
|
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.
|
void |
setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
Sets
IDfAcsTransferPreferences object to be used. |
void |
setDownloadContent(boolean downloadContent)
If you do not want to download content, set this to false.
|
void |
setExportDescendants(boolean exportDescendants)
If the object corresponding to this node is added as a virtual document, passing
true will
cause the object to be checked out, but all the descendants will be downloaded but not checked out. |
void |
setFilePath(java.lang.String newFilePath)
Sets the local path to the file that contains the content of this node.
|
void |
setFormat(java.lang.String formatName)
Sets the repository format name of the local content file for this object.
|
void |
setMacOption(int option)
Sets the Macintosh behavior options for this node.
|
void |
setMacResourceFilePath(java.lang.String resourceForkFilePath)
Specifies the file path to use to store the resource fork information.
|
boolean |
shouldDownloadContent()
Returns false if download content is set to false, true otherwise.
|
getChildren, getEdgeProperties, getId, getOperation, getParent, getPersistentProperties, getProperties, isRoot
IDfSysObject getObject() throws DfException
DfException
IDfSysObject
IDfId getObjectId() throws DfException
DfException
IDfTypedObject.getObjectId()
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
,
IDfSysObject.getContentType()
void setFormat(java.lang.String formatName) throws DfException
formatName
- repository format name (for example, msw6).DfException
IDfFormat
,
IDfSysObject.getContentType()
void setMacResourceFilePath(java.lang.String resourceForkFilePath)
resourceForkFilePath
- java.lang.String getMacResourceFilePath()
int 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 will be 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.
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 will be downloaded only if one is already available in repository. REQUIRE_RESOURCE_FORK - Resource fork is required. An error will be 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)
downloadContent
- if false the content will not be downloaded.boolean shouldDownloadContent()
void setExportDescendants(boolean exportDescendants) throws DfException
true
will
cause the object to be checked out, but all the descendants will be downloaded but not checked out.
The descendants are downloaded as read-only.
Pass true
to download descendants but not check them out.
The default is to download and checkout descendants.exportDescendants
- if true the object corresponding to this node will be checked out, but not
the descendants.DfException
IDfAcsTransferPreferences getAcsTransferPreferences()
IDfAcsTransferPreferences
object to be used.void setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
IDfAcsTransferPreferences
object to be used.acsTransferPreferences
- IDfAcsTransferPreferences
object to be usedIDfEnumeration getAcsRequests() throws DfException
IDfEnumeration
object with a list of IDfAcsRequest
objects.
IDfAcsRequest
objects record information about a client application's request to an
ACS server.IDfEnumeration
of IDfAcsRequest
objectsDfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.