public interface IDfDeleteOperation extends IDfOperation
Modifier and Type | Field and Description |
---|---|
static int |
ALL_VERSIONS
Delete all versions of the object.
|
static int |
SELECTED_VERSIONS
Delete the selected version of the object.
|
static int |
UNUSED_VERSIONS
Delete the unused versions of the object.
|
GENERATE_RESOURCE_FORK, IGNORE_RESOURCE_FORK, REQUIRE_RESOURCE_FORK, RESOURCE_FORK_UNDEFINED, USE_RESOURCE_FORK_IF_AVAILABLE
Modifier and Type | Method and Description |
---|---|
void |
enableDeepDeleteFolderChildren(boolean deepDeleteChildren)
When working with folders, delete the folder and all descendants, regardless of other
folders into which they are linked.
|
void |
enableDeepDeleteVirtualDocumentsInFolders(boolean deepDeleteVDocs)
During a delete operation, the user can decide to delete a folder with all its descendants.
|
boolean |
getDeepFolders()
When working with folders, delete the folder and all of its descendants.
|
IDfList |
getObjects()
Returns the list of unique objects in this operation.
|
int |
getVersionDeletionPolicy()
Returns the delete operation population type.
|
void |
setDeepFolders(boolean deepFolders)
When working with folders, delete the folder and all of its descendants.
|
void |
setVersionDeletionPolicy(int whichVersions)
Sets the delete operation population type.
|
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 SELECTED_VERSIONS
static final int UNUSED_VERSIONS
static final int ALL_VERSIONS
int getVersionDeletionPolicy() throws DfException
DfException
void setVersionDeletionPolicy(int whichVersions) throws DfException
whichVersions
- indicating 0=SELECTED_VERSIONS, 1=UNUSED_VERSIONS, 2=ALL_VERSIONS.DfException
IDfList getObjects() throws DfException
DfException
IDfSysObject
boolean getDeepFolders()
true
if deep delete of folder needs to be performed, false
otherwise.void setDeepFolders(boolean deepFolders)
deepFolders
- true
if deep delete of folder needs to be performed, false
otherwise.void enableDeepDeleteVirtualDocumentsInFolders(boolean deepDeleteVDocs)
false
will not delete the virtual document children
that are in different folder(s). The default is true
(that is, DFC will delete the virtual document children
that reside in different folders).deepDeleteVDocs
- true
if you want to delete the children of the vitual documentum,
false
otherwise. The default is true
.void enableDeepDeleteFolderChildren(boolean deepDeleteChildren)
false
is passed to this method,
folder descendants that are linked into other folders will not be deleted. Instead, they
will be unlinked from the folder(s) being deleted.
Default is true
.deepDeleteChildren
- false
to not delete children linked outside folder(s).Copyright 1994-2023 OpenText Corporation. All rights reserved.