public interface IDfExportNode extends IDfOperationNode
Modifier and Type | Field and Description |
---|---|
static int |
PAGE_RANGE_UNKNOWN |
Modifier and Type | Method and Description |
---|---|
IDfEnumeration |
getAcsRequests()
Returns an
IDfEnumeration object containing a list of IDfAcsRequest objects. |
IDfAcsTransferPreferences |
getAcsTransferPreferences()
Returns the
IDfAcsTransferPreferences object to be used. |
int |
getContentPageNumber()
Returns the content page number for the local content fille for this object.
|
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 Mac 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.
|
java.lang.String |
getPageModifier()
Returns the content page modifier for the local content file for this object.
|
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 |
setContentPageNumber(int pageNumber)
Sets the content page number for the local content fille of this object.
|
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 |
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 |
setLogicalPageRange(int startPage,
int endPage)
Sets the page range of interest that needs to be retrieved as a result of the execution of the export operation.
|
void |
setMacOption(int option)
Sets the Mac behavior options for this node.
|
void |
setMacResourceFilePath(java.lang.String resourceForkFilePath)
Specifies the file path to use to store the resource fork information.
|
void |
setPageModifier(java.lang.String pageModifier)
Sets the content page modifier for the local content file for this object.
|
void |
setRecordInRegistry(int registryRecordingPreference)
Sets an integer that indicates if this node should be
recorded in the client registry.
|
getChildren, getEdgeProperties, getId, getOperation, getParent, getPersistentProperties, getProperties, isRoot
static final int PAGE_RANGE_UNKNOWN
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()
,
IDfSysObject.addRendition(java.lang.String, java.lang.String)
java.lang.String getDefaultFormat() throws DfException
DfException
IDfFormat
,
IDfSysObject.getContentType()
,
IDfSysObject.addRendition(java.lang.String, java.lang.String)
void setFormat(java.lang.String formatName) throws DfException
formatName
- repository format name (e.g. msw6).DfException
IDfFormat
,
IDfSysObject.getContentType()
,
IDfSysObject.addRendition(java.lang.String, java.lang.String)
int getContentPageNumber() throws DfException
DfException
IDfSysObject.setFileEx(java.lang.String, java.lang.String, int, java.lang.String)
void setContentPageNumber(int pageNumber) throws DfException
pageNumber
- content page number for the local content fille of this object.DfException
IDfSysObject.setFileEx(java.lang.String, java.lang.String, int, java.lang.String)
int getRecordInRegistry() throws DfException
Possible values include: 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
Possible values include: 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
java.lang.String getPageModifier() throws DfException
DfException
IDfSysObject.getFileEx(java.lang.String, java.lang.String, int, boolean)
,
IDfSysObject.getFileEx2(java.lang.String, java.lang.String, int, java.lang.String, boolean)
void setPageModifier(java.lang.String pageModifier) throws DfException
pageModifier
- content page modifier for the local content file for this object.DfException
IDfSysObject.getFileEx(java.lang.String, java.lang.String, int, boolean)
,
IDfSysObject.getFileEx2(java.lang.String, java.lang.String, int, java.lang.String, boolean)
void setMacResourceFilePath(java.lang.String resourceForkFilePath)
resourceForkFilePath
- java.lang.String getMacResourceFilePath()
int getMacOption()
Possible values include: IGNORE_RESOURCE_FORK - No resource fork will be outputted, even if 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 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)
Possible values include: IGNORE_RESOURCE_FORK - No resource fork will be outputted, even if 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 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 setIncludeDCTMAttrsInXML(boolean includeDCTMAttrsInXML)
includeDCTMAttrsInXML
- if true the external references will not be downloaded.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 usedIDfEnumeration getAcsRequests() throws DfException
IDfEnumeration
object containing a list of IDfAcsRequest
objects.
IDfAcsRequest
objects record information about a client application's request to an
ACS server.IDfEnumeration
of IDfAcsRequest
objectsDfException
void setLogicalPageRange(int startPage, int endPage) throws DfException
startPage
- logical starting page of the pages requested. Use IDfExportNode.PAGE_RANGE_UNKNOWN if page
range is not known.endPage
- logical ending page of the pages requested. Use IDfExportNode.PAGE_RANGE_UNKNOWN if page range
is not known.DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.