Uses of Class
com.documentum.fc.common.DfException

Packages that use DfException

Package	Description
com.documentum.com	Provides an interface for accessing the DFC through OLE/COM.
com.documentum.fc.bpm
com.documentum.fc.client
com.documentum.fc.client.acs	Provides classes and interfaces, related to distributed content transfer.
com.documentum.fc.client.aspect
com.documentum.fc.client.content
com.documentum.fc.client.fulltext
com.documentum.fc.client.search	Provides classes and interfaces for constructing and running search queries against multiple content repositories as well as external information sources (optional).
com.documentum.fc.client.search.filter	This package contains interfaces to provide search services filters.
com.documentum.fc.common	Provides classes and interfaces to utility functionality associated with all DFC objects.
com.documentum.fc.lifecycle	Provides interfaces for defining logic on lifecycles.
com.documentum.operations	Provides interfaces to common high-level client functionality, such as functionality for checking in and checking out documents, and checking out all the documents in a virtual document.
com.documentum.registry	Provides interfaces and classes that manage Documentum information on the client’s local system.
com.documentum.xml.xdql	Provides interfaces and classes that allow querying of the docbase with results returned as XML.
com.documentum.xml.xquery

Uses of DfException in com.documentum.com

Methods in com.documentum.com that throw DfException

Modifier and Type	Method	Description
Object	DfClientX.deserializeObject(String image)
Object	IDfClientX.deserializeObject(String image)	Restores the object from its serialized image.
IDfCancelCheckoutOperation	DfClientX.getCancelCheckoutOperation()
IDfCancelCheckoutOperation	IDfClientX.getCancelCheckoutOperation()	Factory method that constructs a new IDfCancelCheckout object.
IDfCheckinOperation	DfClientX.getCheckinOperation()
IDfCheckinOperation	IDfClientX.getCheckinOperation()	Factory method that constructs a new IDfCheckinOperation object for checking in one or more checked out repository objects.
IDfCheckoutOperation	DfClientX.getCheckoutOperation()
IDfCheckoutOperation	IDfClientX.getCheckoutOperation()	Factory method that constructs a new IDfCheckoutOperation object for checking in one or more repository objects previously checked out.
IDfClientRegistry	DfClientX.getClientRegistry()
IDfClientRegistry	IDfClientX.getClientRegistry()	Factory method that constructs a new IDfClientRegistry object that provides access to the Docbase object information stored on the local system.
IDfCopyOperation	DfClientX.getCopyOperation()
IDfCopyOperation	IDfClientX.getCopyOperation()	Factory method that constructs a new IDfCopyOperation object.
IDfDeleteOperation	DfClientX.getDeleteOperation()
IDfDeleteOperation	IDfClientX.getDeleteOperation()	Factory method that constructs a new IDfDeleteOperation object.
IDfDocbrokerClient	DfClientX.getDocbrokerClient()
IDfDocbrokerClient	IDfClientX.getDocbrokerClient()	Factory method that contructs a new IDfDocbrokerClient instance.
IDfExportOperation	DfClientX.getExportOperation()
IDfExportOperation	IDfClientX.getExportOperation()	Factory method that constructs a new IDfExportOperation object for exporting one or more repository objects to the file system.
IDfFile	DfClientX.getFile(String filePath)
IDfFile	IDfClientX.getFile(String filePath)	Factory method that constructs a new IDfFile object that represents a file system file.
IDfFormatRecognizer	DfClientX.getFormatRecognizer(IDfSession session, String filePath, String suggestedFormat)
IDfFormatRecognizer	IDfClientX.getFormatRecognizer(IDfSession session, String filePath, String suggestedFormat)	Factory method that constructs a new IDfFormatRecognizer object that is used to suggest what Docbase formats might be appropriate for the specified file.
IDfImportOperation	DfClientX.getImportOperation()
IDfImportOperation	IDfClientX.getImportOperation()	Factory method that constructs a new IDfImportOperation object for importing one or more files into the repository.
IDfClient	DfClientX.getLocalClient()
IDfClient	IDfClientX.getLocalClient()	Factory method for an IDfClient object.
IDfClient	DfClientX.getLocalClient32()
IDfClient	IDfClientX.getLocalClient32()	Returns a DFC local client object that will call into DMCL32.dll for backward compatibility with pre-4.0 Documentum servers.
IDfFormatRecognizer	DfClientX.getMacFormatRecognizer(IDfSession session, String dataForkPath, String resForkPath, String suggestedFormat)
IDfFormatRecognizer	IDfClientX.getMacFormatRecognizer(IDfSession session, String dataForkpath, String resourceForkPath, String suggestedFormat)	Factory method that constructs a new IDfFormatRecognizer object that is used to suggest what Docbase formats might be appropriate based on both the data and resource forks of a Macintosh file.
IDfMoveOperation	DfClientX.getMoveOperation()
IDfMoveOperation	IDfClientX.getMoveOperation()	Factory method that constructs a new IDfMoveOperation object.
IDfOperation	DfClientX.getOperation(String operationName)
IDfOperation	IDfClientX.getOperation(String operationName)	Deprecated. As of DFC 5.3, replaced by one of the getXxxxOperation methods
IDfPredictiveCachingOperation	DfClientX.getPredictiveCachingOperation()
IDfPredictiveCachingOperation	IDfClientX.getPredictiveCachingOperation()	Factory method that constructs a new IDfPredictiveCachingOperation object for predictive content caching.
IDfValidationOperation	DfClientX.getValidationOperation()
IDfValidationOperation	IDfClientX.getValidationOperation()	Factory method that constructs a new IDfValidationOperation object.
IDfVirtualDocument	DfClientX.getVirtualDocument(IDfSysObject rootObject, String lateBindingValue, boolean followRootAssembly)
IDfVirtualDocument	IDfClientX.getVirtualDocument(IDfSysObject rootObject, String lateBindingValue, boolean followRootAssembly)	Returns a virtual document object where the provided IDfSysObject is the root object of the virtual document.
IDfVirtualDocumentNode	DfClientX.getVirtualDocumentNodeFromToken(IDfSession session, String token)
IDfVirtualDocumentNode	IDfClientX.getVirtualDocumentNodeFromToken(IDfSession session, String token)	Returns an interface to a node of a virtual document given a unique token that represents the node in the virtual document tree.
IDfXMLTransformOperation	DfClientX.getXMLTransformOperation()
IDfXMLTransformOperation	IDfClientX.getXMLTransformOperation()	Factory method that constructs a new IDfTransformOperation object for using XSLT to transform one or more XML documents into another form, such as HTML, PDF, etc.
com.documentum.xml.xquery.IDfXQueryTargets	DfClientX.getXQueryTargets(int targetCategory)
com.documentum.xml.xquery.IDfXQueryTargets	IDfClientX.getXQueryTargets(int targetCategory)	Factory method that constructs a new IDfXQueryTargets object.

Uses of DfException in com.documentum.fc.bpm

Methods in com.documentum.fc.bpm that throw DfException

Modifier and Type	Method	Description
String	IDfAttributeValueCondition.getAttributeName()	Returns the name of the attribute of the package component's data type that is to participate in the relational operation with a constant value.
String	IDfXPathConditionEx.getDefaultXPathNamespace()	The default (ie.
String	IDfTransitionCondition.getObjectAlias()	The alias of the object upon which the transition condition is to be applied.
int	IDfTransitionCondition.getRelationalOperator()	Returns an integer specifying which relational operator to use for this transition condition.
int	IDfAttributeValueCondition.getRepeatingAttributeFlag()	Returns the repeating attribute flag that determines how a comparison is performed when the named attribute is repeating.
IDfValue	IDfAttributeValueCondition.getValue()	The value for use within the comparison in the form of an IDfValue instance.
String	IDfXPathCondition.getXPathExpression()	The XPath expression addressing a textual entity within a package component's primary content.
String	IDfXPathConditionEx.getXPathNamespace(String prefix)	The namespace URI to which the given prefix refers within the XPath expression.
IDfProperties	IDfXPathConditionEx.getXPathNamespaces()	A map of all the namespace prefixes and URIs defined for the XPath expression.
String	IDfXPathCondition.getXPathValue()	Gets the String value (formatted according to XSchema datatype) against which the runtime comparison will be made
String	IDfXPathCondition.getXSchemaDatatype()	The built-in XSchema datatype (for example, gDateTime) that determines how the String value will be interpreted for the runtime comparison.
boolean	IDfTransitionCondition.isValid()	Indicates if a transition condition is complete and has legitimate values.
void	IDfXPathConditionEx.removeXPathNamespace(String prefix)	Removes a namespace definition.
void	IDfAttributeValueCondition.setAttributeName(String name)	Sets the name of the attribute of the package component's data type that is to participate in the comparison with a constant value.
void	IDfAttributeValueCondition.setBooleanValue(boolean value)	Sets a boolean value for use within the comparison.
void	IDfXPathConditionEx.setDefaultXPathNamespace(String uri)	Defines the default (ie.
void	IDfAttributeValueCondition.setDoubleValue(double value)	Sets a double value for use within the comparison.
void	IDfAttributeValueCondition.setIdValue(IDfId value)	Sets an id value for use within the comparison.
void	IDfAttributeValueCondition.setIntValue(int value)	Sets an integer value for use within the comparison.
void	IDfTransitionCondition.setObjectAlias(String name)	Set the alias of the object upon which the transition condition is to be applied.
void	IDfTransitionCondition.setRelationalOperator(int operator)	Sets an integer specifying which relational operator to use for this transition condition.
void	IDfAttributeValueCondition.setRepeatingAttributeFlag(int flag)	Sets the repeating attribute flag to determine how a comparison is performed when the named attribute is repeating.
void	IDfAttributeValueCondition.setStringValue(String value)	Sets a string value for use within the comparison.
void	IDfAttributeValueCondition.setTimeValue(IDfTime value)	Sets a time value for use within the comparison.
void	IDfAttributeValueCondition.setValue(IDfValue value)	Sets a value for use within the comparison in the form of an IDfValue instance.
void	IDfXPathCondition.setXPathExpression(String xpath)	Sets the XPath expression defining the value for runtime comparison.
void	IDfXPathConditionEx.setXPathNamespace(String prefix, String uri)	Defines a namespace referenced within the XPath expression.
void	IDfXPathCondition.setXPathValue(String value)	Sets the value (formatted according to XSchema datatype) against which the runtime comparison will be made.
void	IDfXPathCondition.setXSchemaDatatype(String datatype)	Sets the built-in XSchema datatype (for example, gDateTime) that determines how the String value will be interpreted for the runtime comparison.

Uses of DfException in com.documentum.fc.client

Subclasses of DfException in com.documentum.fc.client

Modifier and Type	Class	Description
class	DfACLException	An exception that occurs when operating on a IDfACL instance.
class	DfAlreadyLinkedException
class	DfAspectOperationException
class	DfAttributeValueException
class	DfAuthenticationException	Signals a problem with authentication of an identity.
final class	DfContentAreaException
class	DfDborNotFoundException	This exception is used to indicate that the DBOR was not found
class	DfDeadlockException
class	DfDocbaseUnreachableException
class	DfDocbrokerException
class	DfDuplicateAspectException
class	DfIdentityException	This exception is thrown when a specific docbase does not have an identity.
class	DfIdNotFoundException	Thrown when a requested Docbase object can not be found.
class	DfIOException	Signals that an I/O exception of some sort has occurred while communicating with the docbase.
class	DfNameNotFoundException	Thrown when a requested Docbase object can not be found.
class	DfNoMatchException	Thrown when a qualification failed to match an object.
class	DfNonExistentAspectException
class	DfNoServersException
class	DfObjectNotFoundException	Thrown when a requested Docbase object can not be found.
class	DfOutOfServerSessionsException
class	DfOutOfSessionsException
class	DfPathNotFoundException	Thrown when a requested Docbase object can not be found.
class	DfPersistentObjectException
class	DfPreferenceException	An exception that occurs when operating on a IDfTypedObject instance.
class	DfPrincipalException	An exception that signals a problem with principal authentication.
class	DfRestrictedAccessException	Signals a restricted session.
class	DfScopingException	DfScopingException class.
class	DfServiceException	This class provides error information.
class	DfServiceInstantiationException	This exception is thrown when a Business Object Service is not properly configured in DBOR (Documentum Business Object registry) and the Java class cannot be instantiated.
class	DfServiceNotFoundException	This exception is thrown when a Business Object Service is not configured in DBOR (Documentum Business Object registry).
class	DfSysObjectException	An exception that occurs when operating on a IDfSysObject instance.
class	DfSysObjectSecurityException
class	DfTypedObjectException	An exception that occurs when operating on a IDfTypedObject instance.
class	DfUserAliasSetNotFoundException
class	DfUserException
class	DfWorkflowException	Exceptions that occur when operating on workflow runtime objects including IDfWorkflow, IDfWorkitem, IDfPackage
class	InvocationException

Methods in com.documentum.fc.client that throw DfException

Modifier and Type	Method	Description
void	IDfWorkflow.abort()	Terminates a workflow.
void	IDfBatchManager.abortBatch()	Abort the batch operation and roll back the batch transaction.
void	IDfSession.abortTrans()	Closes an explicit database transaction and cancels any changes made since the call to IDfSession.beginTrans().
void	IDfSession.abortTransEx(IDfLocalTransaction tx)	abort the transaction specified by the IDfTransaction
void	IDfRouter.acquire(int taskNumber)	Deprecated.
void	IDfWorkitem.acquire()	Acquires a work item for the current user.
void	IDfProcess.addActivity(String actName, IDfId actId, String actType, int actPriority)	Adds an activity to the workflow definition.
void	IDfSessionManagerConfig.addApplicationCode(String value)
IDfId	IDfWorkflow.addAttachment(String componentType, IDfId componentId)	Adds an attachment to the workflow.
IDfId	IDfWorkitem.addAttachment(String componentType, IDfId componentId)	Adds an attachment to the workflow.
void	IDfVirtualDocument.addChangeDescription(int code, IDfId objectId, String contextTag, String description)	Records a change made to a node.
IDfRelation	IDfPersistentObject.addChildRelative(String relationTypeName, IDfId childId, String childLabel, boolean isPermanent, String description)	Creates a Relation object.
void	IDfActivity.addConditionRouteCase(String routeCaseIdentifier, IDfList conditions, IDfList outputPorts)	Adds a route case to the activity.
IDfId	IDfSysObject.addDigitalSignature(String userName, String reason)	Create an audit trail entry that records the signing of a DfSysObject by a user.
void	IDfAdminClient.addDocbroker(String hostName, int portNumber)	Dynamically adds a connection broker to the list of brokers known to DFC.
void	IDfDocbrokerClient.addDocbroker(String hostName, int portNumber)	Dynamically adds a connection broker to the list of known connection brokers.
void	IDfSession.addDynamicGroup(String groupName)	Adds the session user to the dynamic group for this session.
void	IDfSessionManagerConfig.addDynamicGroup(String value)
IDfId	IDfSysObject.addESignature(String userName, String password, String signatureJustification, String formatToSign, String hashAlgorithm, String preSignatureHash, String signatureMethodName, String applicationProperties, String passThroughArgument1, String passThroughArgument2)	Electronically sign a sysobject.
boolean	IDfGroup.addGroup(String groupName)	Adds a group to this group.
void	IDfProcess.addLink(String linkName, String linkSrcActivity, String linkSrcPortName, String linkDestActivity, String linkDstPortName)	Adds a link to a workflow definition.
IDfVirtualDocumentNode	IDfVirtualDocument.addNode(IDfVirtualDocumentNode parentNode, IDfVirtualDocumentNode insertAfterNode, IDfId objectChronId, String binding, boolean followAssembly, boolean overrideLateBindingValue)	Adds a new node to the virtual document.
IDfVirtualDocumentNode	IDfVirtualDocument.addNodeToNode(IDfVirtualDocumentNode parentNode, IDfVirtualDocumentNode insertAfterNode, IDfVirtualDocumentNode nodeToAdd)	Adds a node to another node in the display.
void	IDfNote.addNote(IDfId targetId, boolean keepPermanent)	Adds an annotation (the current IDfSysObject) to the target object.
void	IDfSysObject.addNote(IDfId targetId, boolean keepPermanent)	Adds an annotation (the current IDfSysObject) to the target object.
IDfId	IDfWorkflow.addPackage(String startActivityName, String inputPortName, String packageName, String packageType, String noteText, boolean notePersistent, IDfList componentId)	Adds a package to a start activity in a workflow.
IDfId	IDfWorkflow.addPackage(String startActivityName, String inputPortName, String packageName, String packageType, String noteText, boolean notePersistent, IDfList componentId, IDfList componentName)	Adds a package to a start activity in a workflow.
IDfId	IDfWorkflowBuilder.addPackage(String startActivityName, String inputPortName, String packageName, String packageType, String noteText, boolean notePersistent, IDfList componentIds)	Adds a package to a start activity in the workflow.
IDfId	IDfWorkitem.addPackage(String packageName, String packageType, IDfList componentId)	Adds a package to a work item.
IDfId	IDfWorkitem.addPackage(String packageName, String packageType, IDfList componentId, IDfList componentName)	Adds a package to a work item.
IDfId	IDfWorkflow.addPackageEx(String startActivityName, String inputPortName, String packageName, String packageType, String noteText, boolean notePersistent, IDfList componentId, int skillLevel)	Adds a package to a start activity in the workflow and specifies a skill_level for the package
IDfId	IDfWorkflow.addPackageEx(String startActivityName, String inputPortName, String packageName, String packageType, String noteText, boolean notePersistent, IDfList componentId, IDfList componentName, int skillLevel)	Adds a package to a start activity in the workflow and specifies a skill_level for the package
IDfId	IDfWorkitem.addPackageEx(String packageName, String packageType, IDfList componentId, int skillLevel)	Adds a package to a work item and specifies a skill level for the package.
IDfId	IDfWorkitem.addPackageEx(String packageName, String packageType, IDfList componentId, IDfList componentName, int skillLevel)	Adds a package to a work item and specifies a skill level for the package.
void	IDfActivity.addPackageInfo(String portName, String packageName, String packageType, IDfId packageId, String packageLabel, String packageOperation)	Adds a package definition to a port in the activity.
void	IDfActivity.addPackageInfoEx(String portName, String packageName, String packageType, IDfId packageId, String packageLabel, String packageOperation, int packageFlag)	Adds a package definition to a port in the activity.
void	IDfActivity.addPackageInfoEx(String portName, String packageName, String packageType, IDfId packageId, String packageLabel, String packageOperation, int packageFlag, int packageReportFlag)	Adds a package definition to a port in the activity.
void	IDfWorkflow.addPackageToInitiateAct(String packageName, String packageType, IDfList componentId)	This funtion would add the package to the start activities linked with the initiate activity that has been previously set by the setInitiateAct() API, if the package is defined on some input port of each start activity.
void	IDfWorkflow.addPackageToInitiateAct(String packageName, String packageType, IDfList componentId, String noteText, boolean persistentNote, int skillLevel)	This funtion would add the package to the start activities linked with the initiate activity that has been previously set by the setInitiateAct() API, if the package is defined on some input port of each start activity.
IDfRelation	IDfPersistentObject.addParentRelative(String relationTypeName, IDfId parentId, String childLabel, boolean isPermanent, String description)	Creates a Relation object.
void	IDfActivity.addPerformerCondition(String conditionName, String condition, IDfList performers)	Adds a performer case to the activity.
void	IDfActivity.addPort(String portName, String portType)	Adds a port to the activity.
void	IDfActivity.addPostTimerAction(IDfId action, int minutes)	Establishes a timer at the end of the series.
void	IDfActivity.addPreTimerAction(IDfId action, int minutes)	Establishes a timer at the end of the series.
IDfId	IDfSysObject.addReference(IDfId folderId, String bindingCondition, String bindingLabel)	Add a reference to the object in another folder.
void	IDfSysObject.addRendition(String fileName, String formatName)	Adds a new rendition to the object.
void	IDfSysObject.addRenditionEx(String fileName, String formatName, int pageNumber, String storageName, boolean atomic)	This is the extended method for adding a new rendition to the object..
void	IDfSysObject.addRenditionEx2(String fileName, String formatName, int pageNumber, String pageModifier, String storageName, boolean atomic, boolean keep, boolean batch)	This is the extended method for adding a new rendition to the object..
void	IDfSysObject.addRenditionEx3(String fileName, String formatName, int pageNumber, String pageModifier, String storageName, boolean atomic, boolean keep, boolean batch, String otherFileName)	This is the extended method for adding a new rendition to the object..
void	IDfActivity.addRouteCase(String routeCaseIdentifier, String condition, IDfList outputPorts)	Adds a route case to the activity.
void	DfClient.addUnavailableAcsServer(String urlString)
void	IDfClient.addUnavailableAcsServer(String urlString)	Deprecated. use IDfAcsClient.addUnavailableAcsServer()
boolean	IDfGroup.addUser(String userName)	Adds a user to this group.
IDfSession	DfClient.adoptDMCLSession(String dmclSessionId)
IDfSession	IDfClient.adoptDMCLSession(String dmclSessionId)	Deprecated. session adoption is no longer useful without a separate DMCL
IDfList	IDfSession.apiDesc(String api)	Deprecated.
boolean	IDfPersistentObject.apiExec(String cmd, String args)	Deprecated. DMCL passthrough should not be used anymore
boolean	IDfSession.apiExec(String cmd, String args)	Deprecated.
String	IDfPersistentObject.apiGet(String cmd, String args)	Deprecated. DMCL passthrough should not be used anymore
String	IDfSession.apiGet(String cmd, String args)	Deprecated.
ByteArrayInputStream	IDfSession.apiGetBytes(String cmd, String args, String buf, String buflen, int length)	Deprecated.
boolean	IDfPersistentObject.apiSet(String cmd, String args, String value)	Deprecated. DMCL passthrough should not be used anymore
boolean	IDfSession.apiSet(String cmd, String args, String value)	Deprecated.
boolean	IDfSession.apiSetBytes(String cmd, String args, ByteArrayOutputStream content)	Deprecated.
void	IDfProcess.appendActPerformer(int actPerfRule, String actPerfFrom, String actPerfTo)	Append values to parallel attributes: act_performer_rule/act_performer_from/act_performer_to
int	IDfAliasSet.appendAlias(String name, String value, int category, int userCategory, String description)	Appends an alias to the alias set.
void	IDfTypedObject.appendBoolean(String attributeName, boolean value)	Appends a boolean value to a repeating attribute.
void	IDfSysObject.appendContent(ByteArrayOutputStream content)	Appends new content to an object.
void	IDfSysObject.appendContentEx(ByteArrayOutputStream content, boolean other)	Appends new content to an object.
void	IDfTypedObject.appendDouble(String attributeName, double value)	Appends a double value to a repeating attribute.
void	IDfSysObject.appendFile(String fileName)	Appends new content to an object.
void	IDfSysObject.appendFileEx(String fileName, String otherFileName)	Appends new content to an object.
void	IDfTypedObject.appendId(String attributeName, IDfId value)	Appends an ID value to a repeating attribute.
void	IDfTypedObject.appendInt(String attributeName, int value)	Appends an integer value to a repeating attribute.
int	IDfPackage.appendNote(String text, boolean persistent)	Adds a note to a package.
void	IDfPackage.appendNoteEx(IDfId annotationId, boolean persistent)	Adds a note to a package.
IDfId	IDfSysObject.appendPart(IDfId componentId, String versionLabel, boolean useNodeVerLabel, boolean followAssembly, int copyChild)	Appends a document as the last virtual document child of the object.
int	IDfPolicy.appendState()	Append a new state to this lifecycle.
void	IDfTypedObject.appendString(String attributeName, String value)	Appends a string value to a repeating attribute.
int	IDfRouter.appendTask()	Deprecated.
void	IDfTypedObject.appendTime(String attributeName, IDfTime value)	Appends a date/time value to a repeating attribute.
void	IDfTypedObject.appendValue(String attributeName, IDfValue value)	Appends a value stored in an IDfValue object to a repeating attribute.
IDfCollection	IDfSession.apply(String objId, String functionName, IDfList args, IDfList dataType, IDfList values)	Calls the server API Apply method.
void	IDfSysObjectRetention.applyRetention(IDfId retainerId)	Places object under retention by the specified dm_retainer object.
IDfId	IDfSession.archive(String predicate, String operatorName, int priority, boolean sendMail, IDfTime dueDate)	Queues an archive request to the repository operator.
boolean	IDfSysObject.areAttributesModifiable()	Returns whether this object's attributes can be modified.
boolean	IDfVirtualDocumentNode.areChildrenCompound()	Indicates whether users can add, remove, or reorder the children of this node through VDM.
IDfCollection	IDfSysObject.assemble(IDfId virtualDocId, int interruptFreq, String qualification, String nodesortList)	Creates an assembly and associates it with the object.
void	IDfVirtualDocumentNode.assemble(IDfSysObject object)	Creates an assembly for the node.
void	IDfSession.assume(IDfLoginInfo loginInfo)	Gives ownership of the session to a new user.
IDfVirtualDocument	IDfSysObject.asVirtualDocument(String lateBindingValue, boolean followRootAssembly)	Returns a virtual document representation of the object.
void	IDfSysObject.attachPolicy(IDfId policyId, String state, String scope)	Attaches a business policy object to the object.
void	DfClient.authenticate(String docbaseName, IDfLoginInfo loginInfo)
void	IDfClient.authenticate(String docbaseName, IDfLoginInfo loginInfo)	Validates a username/password combination without returning a new session.
void	IDfSession.authenticate(IDfLoginInfo loginInfo)	Validates credentials without returning a new session.
IDfScope	IDfScopeManager.beginScope(boolean bNested)	Opens an explicit scope boundary.
IDfScope	IDfSessionScopeManager.beginScope(boolean bNested)	Opens an explicit scope boundary.
void	IDfSession.beginTrans()	Opens an explicit database transaction.
IDfLocalTransaction	IDfSession.beginTransEx()	begin a nested transaction
void	IDfSysObject.bindFile(int pageNumber, IDfId srcId, int srcPageNumber)	Binds content associated with an object to another object.
IDfId	IDfSysObject.branch(String versionLabel)	Creates and checks out a new version of an object.
boolean	IDfVirtualDocumentNode.canBeRemoved()	Indicates whether the node can be removed from its parent.
boolean	IDfVirtualDocumentNode.canBeRestructured()	Indicates whether the node can be restructured.
void	IDfSysObject.cancelCheckout()	Removes an intention lock without saving any changes that may have been made to the locked object.
void	IDfSysObject.cancelCheckoutEx(boolean sendMail, String compoundValue, String specialValue)	This is the extended method that removes an intention lock without saving any changes that may have been made to the locked object.
void	IDfSysObject.cancelScheduledDemote(IDfTime scheduleDate)	This will cancel the scheduled demote of the sysobject at the date/time specifed by scheduleDate.
void	IDfSysObject.cancelScheduledPromote(IDfTime scheduleDate)	This will cancel the scheduled promote for the date/time specified in the scheduleDate argument.
void	IDfSysObject.cancelScheduledResume(IDfTime schedule)	This will cancel a scheduled resume of the sysobject for a certain date/time.
void	IDfSysObject.cancelScheduledSuspend(IDfTime scheduleDate)	This method can be used to cancel a scheduled suspend of the sysobject at a date/time.
boolean	IDfVersionPolicy.canCheckinFromFile()	Indicates whether the object's content file can be overwritten by an external file when the object is checked in to the repository.
boolean	IDfSysObject.canDemote()	Returns whether the object can be demoted from the current state.
boolean	IDfFormat.canIndex()	Indicates if a format can be full-text indexed.
boolean	IDfSysObject.canPromote()	Returns whether the sysobject can be promoted from current state to the next state.
boolean	IDfSysObject.canResume()	Returns whether the sysobject can be resumed from an exception state.
boolean	IDfSysObject.canSuspend()	Returns whether the sysobject can suspend from its current state to the exception state.
boolean	IDfSysObjectRetention.canSwapRetainer(IDfId oldRetainerId, IDfId newRetainerId)
boolean	IDfVersionPolicy.canVersion(int toVersion)	Tests whether an object may be saved as the next major, minor, branch, or same version.
boolean	IDfVirtualDocumentNode.causesCycle()	Indicates whether the node's object ID matches that of any of its parents in the virtual document hierarchy.
void	IDfUser.changeHomeDocbase(String userName, boolean isImmediate)	Change the home repository of this user.
void	IDfSession.changePassword(String oldPasswd, String newPasswd)	Changes a password.
void	IDfRetainer.changeRetentionStatus(int retentionStatus)	This call changes the status of the dm_retainer object.
com.documentum.fc.client.DormantStatus	IDfSession.checkDormantStatus()	Checks the status of the server to which this session is connected For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
com.documentum.fc.client.DormantStatus	IDfSession.checkDormantStatus(boolean allServersForThisDocbase)	Checks whether a server or docbase is dormant or not For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
IDfId	IDfSysObject.checkin(boolean keepLock, String versionLabels)	Creates a new version of this object and removes the lock from the previous version.
IDfId	IDfSysObject.checkinEx(boolean keepLock, String versionLabels, String oldCompoundArchValue, String oldSpecialAppValue, String newCompoundArchValue, String newSpecialAppValue)	This is the extended method for checkin.
void	IDfSysObject.checkout()	Places a lock on the object.
IDfId	IDfSysObject.checkoutEx(String versionLabel, String compoundArchValue, String specialAppValue)	Places a lock on the object.
void	IDfScopeManager.clearDefaultScope(com.documentum.fc.client.ScopeBoundary boundary)	Removes one default scoping policy.
void	IDfScopeManager.clearScopes()	Pops all the scopes from the scope stack.
void	IDfSessionScopeManager.clearScopes()	Pops all the scopes from the scope stack.
void	IDfCollection.close()	Closes a collection object.
void	IDfBatchManager.closeBatch()	Flush the batch, commit the transaction, and close the batch.
IDfCollection	IDfSession.collectMetrics(List<String> metricsToCollect)	This methods indicates to the server to collect the metrics that have been passed in to this method.
IDfCollection	IDfSession.collectMetrics(List<String> metricsToCollect, String outputFormat)	This methods indicates to the server to collect the metrics that have been passed in to this method.
void	IDfBatchManager.commitBatch()	Flush the batch data into the repository and commit the transaction for the batch.
void	IDfSession.commitTrans()	Commits all changes made after a IDfSession.beginTrans() method call.
void	IDfSession.commitTransEx(IDfLocalTransaction tx)	commit the transaction specified by the IDfLocalTransaction
void	IDfWorkitem.complete()	Marks a work item as finished.
void	IDfWorkitem.completeEx(int returnValue, String execOSError, IDfId execResultId)	Marks the work item as complete.
void	IDfWorkitem.completeEx2(int returnValue, String execOSError, IDfId execResultId, int userTime, double userCost)	Marks the work item as complete.
IDfId	IDfAuditTrailManager.createAudit(IDfId objectId, String event, String[] stringArgs, IDfId[] idArgs)	Creates an audit trail entry for application events.
String	DfClient.decryptText(String s1, String s2)
String	IDfClient.decryptText(String s1, String s2)	Deprecated.
void	IDfWorkitem.delegateTask(String user)	Delegates the work item to someone else.
void	IDfLightObject.dematerialize()	Turn a materialized lightobject back into an unmaterialized lightobject by reparenting to the original shared parent.
void	IDfSysObject.demote(String state, boolean toBase)	This method will demote the sysobject from its current normal state to the previous normal state, or to the base state if the toBase parameter is set to true.
void	IDfSession.dequeue(IDfId stampId)	Removes items from an inbox that were placed there using the queue method.
void	IDfSession.dequeueAll()	Removes all items from an inbox that were placed there using the queue method.
String	IDfSession.describe(String type, String objType)	Describes the attributes of a type or registered table.
void	IDfPersistentObject.destroy()	Removes the object from the Documentum server.
void	IDfACL.destroyACL(boolean force)	Removes an ACL object from a repository.
void	IDfSysObject.destroyAllVersions()	Destroys all versions of the object.
void	IDfSysObject.detachPolicy()	Detaches an existing business policy object from the object.
boolean	IDfSession.disableSaveInDormantState()	Disables save operation for dormant state.
void	IDfSysObject.disassemble()	Disassembles the assembly associated with the object.
void	IDfVirtualDocumentNode.disassemble()	Disassembles an assembly.
void	IDfSession.disconnect()	Disconnects the DFC session.
boolean	IDfVirtualDocumentNode.doesSelectedVersionMatchBinding()	Indicates whether the currently displayed node object matches the defined binding for the node.
String	IDfTypedObject.dump()	Lists an object's attributes and their values.
boolean	IDfSession.enableSaveInDormantState()	Enables save operation for dormant state.
void	IDfSessionScopeManager.enableServerScope(boolean enable)	Enables or disables server-side scoping.
String	DfClient.encryptPassword(String password)
String	IDfClient.encryptPassword(String password)	Encrypts a password.
String	DfClient.encryptText(String s1, String s2)
String	IDfClient.encryptText(String s1, String s2)	Deprecated.
void	IDfRouter.end()	Deprecated.
void	IDfScopeManager.endScope()	Closes the explicit scope boundary.
void	IDfSessionScopeManager.endScope()	Closes the explicit scope boundary.
Enumeration	IDfTypedObject.enumAttrs()	Returns an enumeration of IDfAttr objects.
Enumeration	DfClient.enumSharedSessions(String key)
Enumeration	IDfClient.enumSharedSessions(String key)	Deprecated. use IDfSessionManager instead for session sharing
String	IStorageRuleEvaluator.evaluate(IDfSysObject sysObj, com.documentum.fc.client.DfContentInfo contentInfo, IDfSession session, Object obj)	This method is used to evaluate the rules in the policy.
IDfCollection	IDfQuery.execute(IDfSession session, int queryType)	Executes a DQL query.
void	IDfWorkflow.execute()	Starts a workflow.
String	IDfSession.exportTicketKey(String password)	Returns the login ticket key of the repository.
boolean	IDfPersistentObject.fetch(String typeNameIgnored)	Fetches this object from the repository without placing a lock on the object.
boolean	IDfPersistentObject.fetchWithCaching(String currencyCheckValue, boolean usePersistentCache, boolean useSharedCache)	Fetches this object from the repository without placing a lock on the object.
IDfVirtualDocumentNode	IDfVirtualDocument.find(IDfVirtualDocumentNode startNode, String searchString, String attributeList, int flags)	Returns the node corresponding to a specified search string.
int	IDfAliasSet.findAliasIndex(String name)	Returns the index position of an alias in the alias set.
int	IDfTypedObject.findAttrIndex(String attributeName)	Returns the position of an attribute in the list of attributes that belong to this object.
int	IDfTypedObject.findBoolean(String attributeName, boolean value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified boolean value.
int	IDfTypedObject.findDouble(String attributeName, double value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified double value.
int	IDfTypedObject.findId(String attributeName, IDfId value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified ID value.
int	IDfTypedObject.findInt(String attributeName, int value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified integer value.
IDfSession	DfClient.findSession(String sessionId)
IDfSession	IDfClient.findSession(String sessionId)	Returns an existing DFC session using a DFC session ID.
int	IDfTypedObject.findString(String attributeName, String value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified string value.
int	IDfTypedObject.findTime(String attributeName, IDfTime value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified date/time value.
int	IDfType.findTypeAttrIndex(String attrName)	Returns the index of an attribute.
int	IDfTypedObject.findValue(String attributeName, IDfValue value)	Searches through the values in a repeating attribute and returns the index of the first value that matches the specified value.
void	IDfSession.flush(String flushType, String cacheKey)	Removes cached queries from the client's query caches, ACLs and Group objects from the session cache, and type information from the data dictionary cache.
void	IDfBatchManager.flushBatch()	Flush the batch data into the repository.
void	IDfSession.flushCache(boolean discardChanged)	Removes objects from the server and client caches.
void	IDfSession.flushCachedQuery(String dqlQuery)	Remove the specified query from the query cache.
void	IDfSession.flushEx(String flushType, String cacheKey, boolean resetChangeBit, boolean includeSubtypes)	Removes cached queries from the client's query caches, ACLs and Group objects from the session cache, and type information from the data dictionary cache.
void	IDfSession.flushGlobalCache(String cacheName)	Removes objects from a global server cache.
void	IDfSession.flushObject(IDfId objectId)	Remove the specified object from the cache.
void	IDfRouter.force(int taskNumber, String message)	Deprecated.
void	IDfRouter.forward(int currentTask, IDfList additionalTask, String message)	Deprecated.
void	IDfSysObject.freeze(boolean freezeComponents)	Marks an object as unchangeable (and optionally its components), if the object is a virtual document.
IDfTime	IDfPackage.getAcceptanceDate()	Returns the acceptance date, which identifies when a package arrived and was accepted by an input port.
IDfTime	IDfSysObject.getAccessDate()	Returns the date the content of this object was last accessed.
String	IDfACL.getAccessorApplicationPermit(int index)	Returns the application permit assigned to a user or group.
String	IDfSysObject.getAccessorApplicationPermit(int index)	Returns the application permit assigned to a user or group.
int	IDfACL.getAccessorCount()	Returns the number of users and groups referenced in an ACL object.
int	IDfSysObject.getAccessorCount()	Returns the number of users or groups for whom some level of access is defined for the object.
String	IDfACL.getAccessorName(int index)	Returns the name of an individual user, group or alias in an ACL object.
String	IDfSysObject.getAccessorName(int index)	Returns the list of users and groups for whom some level of access is defined for the object.
int	IDfACL.getAccessorPermit(int index)	Returns the basic permission level granted to a user or group.
String	IDfSysObject.getAccessorPermit(int index)	Returns the permit levels assigned to each user or group using the computed attribute _accessor_name.
int	IDfACL.getAccessorPermitType(int index)	Identifies the type of permission granted an accessor in the ACL.
int	IDfSysObject.getAccessorPermitType(int index)	Returns the permit type assigned to each user or group using the computed attribute _accessor_name.
int	IDfACL.getAccessorXPermit(int index)	Returns extended permissions granted to a user or group.
int	IDfSysObject.getAccessorXPermit(int index)	Returns the extended permission levels of the specified user or group using the computed attribute _accessor_name.
String	IDfACL.getAccessorXPermitNames(int index)	Returns the extended permissions in string form assigned to a user or group.
String	IDfSysObject.getAccessorXPermitNames(int index)	Retrieves the extended permissions, in upper case and separated by a comma, that are assigned to each user or group.
IDfACL	IDfSession.getACL(String aclDomain, String aclName)	Returns an ACL object.
IDfACL	IDfSysObject.getACL()	Returns an ACL associated with the object.
int	IDfACL.getACLClass()	Returns the ACL class value.
String	IDfSysObject.getACLDomain()	Returns the domain of the ACL associated with this user.
String	IDfUser.getACLDomain()	Returns the domain of the ACL associated with a user.
String	IDfSysObject.getACLName()	Returns the name of the associated ACL.
String	IDfUser.getACLName()	Returns the name of the ACL associated with a user.
boolean	IDfSysObject.getAclRefValid()	Indicates whether the values in _accessor_name and _accessor_permit have been saved to the repository using the computed attribute _acl_ref_valid.
String	IDfQueueItem.getAContentType()	Returns the content type of the routed object.
IDfEnumeration	IDfSysObject.getAcsRequests(String formatName, int pageNumber, String pageModifier, IDfAcsTransferPreferences transferPreferences)	Returns an IDfEnumeration object containing a list of IDfAcsRequest objects.
IDfTypedObject	IDfDocbrokerClient.getAcsServerMap(String docbaseName)	Returns information about the ACS servers that are known to the set of connection brokers currently configured for this IDfDocbrokerClient instance.
IDfTypedObject	IDfDocbrokerClient.getAcsServerMapFromSpecificDocbroker(String docbaseName, String protocol, String hostName, String portNumber)	Returns information about the ACS servers that are known to a specific connection broker.
String	IDfProcess.getActChooseBy(int index)	Returns the act_choose_by attribute value at the specified index position.
int	IDfProcess.getActChooseByCount()	Returns the number of values in the act_choose_by attribute.
String	IDfProcess.getActChooseFor(int index)	Returns the act_choose_for attribute value at the specified index position.
int	IDfProcess.getActChooseForCount()	Returns the number of values in the act_choose_for attribute.
String	IDfProcess.getActChooseName(int index)	Returns the act_choose_name attribute value at the specified index.
int	IDfProcess.getActChooseNameCount()	Returns the number of values in the act_choose_name attribute.
IDfId	IDfWorkflow.getActDefId(int valueIndex)	Returns the object ID of an activity's definition.
IDfId	IDfWorkitem.getActDefId()	Returns the object ID of the activity definition whose runtime instance generated the work item.
int	IDfWorkflow.getActErrorno(int valueIndex)	Returns the error number for a failed activity operation.
IDfId	IDfPolicy.getActionObjectId(int index)	Return the attribute action_object_id value at the specified index.
int	IDfPolicy.getActionObjectIdCount()	Return the number of attribute action_object_id values for this policy.
IDfActivity	IDfWorkitem.getActivity()	Returns the work item's corresponding activity object.
int	IDfProcess.getActivityCount()	Returns the number of activities in the workflow.
int	IDfWorkflow.getActivityCount()	Returns the number of activity instances in the workflow.
IDfId	IDfProcess.getActivityDefId(int actIndex)	Returns the object ID of an activity's definition.
IDfId	IDfProcess.getActivityIdByName(String actName)	Given an activity name, return the id of the activity.
String	IDfProcess.getActivityName(int actIndex)	Returns an activity name.
int	IDfProcess.getActivityPriority(int actIndex)	Returns an activity's priority.
int	IDfProcess.getActivityType(int actIndex)	Returns an activity's type.
int	IDfProcess.getActivityTypeByName(String actName)	Given an activity name, return the type of the activity.
String	IDfWorkflow.getActName(int valueIndex)	Returns the name of an activity.
int	IDfProcess.getActPerformerCount()	Return the number of entries of the parallel attributes: act_performer_rule/act_performer_from/act_performer_to
int	IDfPackage.getActSeqno()	Returns the sequence number (r_act_seqno) of the activity in which the package is being handled.
int	IDfWorkflow.getActSeqno(int valueIndex)	Returns the sequence number of an activity.
int	IDfWorkitem.getActSeqno()	Returns the sequence number of the activity with which the work item is associated.
int	IDfWorkflow.getActState(int valueIndex)	Returns the state of an activiity.
IDfTime	IDfQueueItem.getActualStartDate()	Returns the date on which work on the item actually started.
String	IDfValueAssistance.getActualValue(String displayValue)	Return the possible actual value mapped to the specified displayValue.
int	IDfRetainer.getAgingMethod()	Returns the dm_retainer.aging_method value.
int	IDfAliasSet.getAliasCategory(int index)	Returns the category of the alias in the specified index position in this alias set.
int	IDfAliasSet.getAliasCount()	Returns the number of aliases in the alias set.
String	IDfAliasSet.getAliasDescription(int index)	Returns the description of the alias at the specified index position in this alias set.
String	IDfAliasSet.getAliasName(int index)	Returns the alias name at the specified index in the list of aliases for the alias set scope.
String	IDfSession.getAliasSet()	Returns the alias set name of this session config object.
String	IDfSysObject.getAliasSet()	Returns the symbolic name of the policy alias set.
String	IDfUser.getAliasSet()	Returns the name of the user's default alias set.
IDfId	IDfGroup.getAliasSetId()	Returns the alias set object id of the group.
IDfId	IDfSysObject.getAliasSetId()	Returns the position of alias-binding scope specified in the associated policy object.
IDfId	IDfUser.getAliasSetId()	Returns the object ID of the user's default alias set.
IDfId	IDfWorkflow.getAliasSetId()	Returns the alias set object id for the workflow instance.
IDfId	IDfPolicy.getAliasSetIds(int index)	Return the alias_set_ids value at the specified index.
int	IDfPolicy.getAliasSetIdsCount()	Return the number of attribute allias_set_ids values for this policy.
int	IDfAliasSet.getAliasUserCategory(int index)	Returns the user category of the alias at the specified index position in the alias set.
String	IDfAliasSet.getAliasValue(int index)	Returns the value corresponding to the alias at the specified index in this alias set.
IDfList	IDfAuditTrailManager.getAllEvents()	Gets a list of all the events(String) available in the repository.
IDfList	IDfPolicy.getAllIncludedTypes()	Retun an IDfList that includes the complete list of types for objects that can be attached to this policy.
IDfEnumeration	DfClient.getAllNetworkLocations(String locale)
IDfEnumeration	IDfClient.getAllNetworkLocations(String locale)	Deprecated. use IDfAcsClient.getAllNetworkLocations()
boolean	IDfPolicy.getAllowAttach(int index)	Return the attribute allow_attach value at the specified index.
int	IDfPolicy.getAllowAttachCount()	Return the number of attribute allow_attach values for this policy.
boolean	IDfPolicy.getAllowDemote(int index)	Return the attribute allow_demote value at the specified index.
int	IDfPolicy.getAllowDemoteCount()	Return the number of attribute allow_demote values for this policy.
boolean	IDfPolicy.getAllowSchedule(int index)	Return the attribute allow_schedule value at the specified index.
int	IDfPolicy.getAllowScheduleCount()	Return the number of attribute allow_schedule values for this policy.
IDfCollection	IDfWorkitem.getAllPackages(String additionalAttributes)	Returns a query result collection containing the following attributes: String documentIDs object ID's of documents, separated by commas String r_package_name String r_packageType String i_package_oprtn IDfId r_note_id
String	IDfTypedObject.getAllRepeatingStrings(String attributeName, String separator)	Returns all the values stored in a repeating attribute as a single string.
String	IDfGroup.getAllUsersNames(int index)	Returns the name (at a specified index) from all users in a group object, including users that belong to group objects contained within this group object.
int	IDfGroup.getAllUsersNamesCount()	Returns the number of users in a group object, including users that belong to group objects contained within this group object.
String	IDfFolder.getAncestorId(int index)	Returns the object ID (as a string) of all the folders or cabinets that contain, directly or indirectly, this folder.
int	IDfFolder.getAncestorIdCount()	Returns the number of folder objects that contain, directly or indirectly, this folder.
IDfId	IDfSysObject.getAntecedentId()	Returns the object id of the object's parent.
IDfList	IDfAuditTrailManager.getApplicableEvents(IDfId objectId)	Gets a list of applicable events(String) for the object.
String	IDfSession.getApplicationToken(String userName, String scope, int timeout, String appId, boolean machineOnly)	Acquires an application access control token.
String	DfClient.getApplicationTokenDiagnostics(String applicationToken)
String	IDfClient.getApplicationTokenDiagnostics(String applicationToken)	Return details extracted from an applicationToken.
String	IDfSysObject.getApplicationType()	Returns the a_application_type attribute of the object.
IDfId	IDfPolicy.getAppValidationId()	Return the attribute app_validation_id value for this policy.
String	IDfPolicy.getAppValidationVer()	Return the attribute app_validation_ver value for this policy.
IDfModuleDescriptor	IDfLocalModuleRegistry.getAspectDescriptor(String aspectName)	Gets the meta data for the Aspect mapped to the aspect name, if found.
IDfEnumeration	IDfLocalModuleRegistry.getAspectDescriptors()	Get a list of all Aspects available .
IDfId	IDfSysObject.getAssembledFromId()	Returns the object id of the virtual document that was the source of the assembly associated with the object.
IDfSysObject	IDfVirtualDocumentNode.getAssemblyDocument()	Returns the document with which an assembly is associated.
String	IDfVirtualDocumentNode.getAssemblyDocumentBinding()	Returns the binding value between the assembly's associated document and that document's parent document.
IDfVirtualDocumentNode	IDfVirtualDocumentNode.getAssemblyParent()	Returns an IDfVirtualDocumentNode object for the root of the assembly that contains this node.
String	IDfFormat.getAssetClass()
IDfWorkflowAttachment	IDfWorkflow.getAttachment(IDfId attachmentId)	Returns an attachment object given the ID of the object.
IDfWorkflowAttachment	IDfWorkitem.getAttachment(IDfId attachmentId)	Returns an attachment object given the ID of the object.
IDfCollection	IDfWorkflow.getAttachments()	Returns a list of all the workflow's attachments.
IDfCollection	IDfWorkitem.getAttachments()	Returns a list of all the workflow's attachments.
IDfAttr	IDfTypedObject.getAttr(int attrIndex)	Returns an attribute description.
IDfList	IDfPersistentObject.getAttrAssistance(String attrName)	Deprecated. use getValidator and then call getValueAssistance on IDfValidator instead
IDfList	IDfPersistentObject.getAttrAssistanceWithValues(String attrName, IDfList depAttrNameList, IDfList depAttrValueListList)	Deprecated. use getValidator and then call getValueAssistance on IDfValidator instead
IDfList	IDfPersistentObject.getAttrAsstDependencies(String attrName)	Deprecated. use getValidator and then call getValueAssistanceDependencies on IDfValidator instead
int	IDfTypedObject.getAttrCount()	Returns the number of attributes belonging to this object.
int	IDfTypedObject.getAttrDataType(String attributeName)	Returns the data type of an attribute.
IDfList	IDfAuditTrail.getAuditData()	This API gets the audit data information for this particular Audit Trail Object.
InputStream	IDfAuditTrail.getAuditDataAsXMLStream()	This API gets an XML representation of an audit data information for this Audit Trail object.
IDfAuditTrailManager	IDfSession.getAuditTrailManager()	Retrieves the Audit Trail manager for this session.
String	IDfSysObject.getAuthors(int index)	Returns the authors attribute at the specified index.
int	IDfSysObject.getAuthorsCount()	Returns the number of values the authors attribute has.
String	IDfDocbaseMap.getAuthProtocol(int index)	Returns the authentication protocol of the repository at the specified index.
IDfId	IDfWorkitem.getAutoMethodId()	Returns the object ID of the method that invokes the work item's application.
IDfVersionTreeLabels	IDfVirtualDocumentNode.getAvailableVersions()	Returns a list of the version labels for the object represented by this node.
com.documentum.fc.common.IDfBasicAttributes	IDfVirtualDocumentNode.getBasicAttributes()
String	IDfVirtualDocumentNode.getBinding()	Returns the version label used to resolve the binding for this node.
IDfId	IDfAssembly.getBookId()	Returns the object ID of the top-most containing virtual document.
boolean	IDfTypedObject.getBoolean(String attributeName)	Returns the boolean value of an attribute.
int	IDfSysObject.getBranchCount()	Returns the number of branches on the version tree that contains the object.
String	IDfVersionPolicy.getBranchLabel()	Returns the next possible branched version label of an object.
int	IDfContentCollection.getBufferSize()
long	IDfContentCollection.getBytePosition()
ByteArrayInputStream	IDfCollection.getBytesBuffer(String cmd, String buf, String buflen, int length)	Reserved for internal use.
IDfId	IDfSysObject.getCabinetId()	Returns the object id of the cabinet that is the object's primary storage location.
IDfChangeDescription	IDfVirtualDocument.getChangeDescription(int index)	Returns the change description at a given index position.
int	IDfVirtualDocument.getChangeDescriptionCount()	Returns a count of the changes made in all open VDM windows.
String	IDfAspectRelation.getChild()	Returns the child aspect name of an aspect relation object.
IDfVirtualDocumentNode	IDfVirtualDocumentNode.getChild(int index)	Returns a given child node of this node.
String	IDfForeignKey.getChildAttribute(int index)	Returns the child key property for the foreign key at the specified index.
int	IDfForeignKey.getChildAttributesCount()	Returns the number child key properties for the foreign key.
int	IDfVirtualDocumentNode.getChildCount()	Returns the number of immediate children for this node.
IDfId	IDfRelation.getChildId()	Returns the object ID of the child object in the relationship.
String	IDfRelation.getChildLabel()	Returns the version label of the child object in the relationship.
IDfCollection	IDfPersistentObject.getChildRelatives(String relationTypeName)	Returns a collection of IDfRelation objects where parent is this object, and the relation_name matches the value passed in as a parameter.
String	IDfRelationType.getChildType()	Returns the object type of a valid child object in the relationship.
IDfId	IDfSysObject.getChronicleId()	Returns the object id of the root object in the version tree.
IDfId	IDfVersionTreeLabels.getChronicleId()	Returns the object ID of the version tree's root version.
IDfId	IDfVirtualDocumentNode.getChronId()	Returns the chronicle ID for the object represented by this node.
int	IDfUser.getClientCapability()	Returns the client capability as an integer.
IDfTypedObject	DfClient.getClientConfig()
IDfTypedObject	IDfClient.getClientConfig()	Returns information about DFC.
IDfTypedObject	IDfSession.getClientConfig()	Returns an api config object.
IDfEnumeration	DfClient.getClientNetworkLocations(String clientIPAddress, String locale)
IDfEnumeration	IDfClient.getClientNetworkLocations(String clientIPAddress, String locale)	Deprecated. use IDfAcsClient.getClientNetworkLocations()
IDfCollection	IDfSysObject.getCollectionForContent(String format, int pageNumber)	Returns a collection containing the object's content in the repository.
IDfCollection	IDfSysObject.getCollectionForContentEx2(String format, int pageNumber, String pageModifier)	Returns a collection containing the object's content in the repository.
IDfCollection	IDfSysObject.getCollectionForContentEx3(String format, int pageNumber, String pageModifier, boolean other)	Returns a collection containing the object's content in the repository.
IDfContentCollection	IDfSysObject.getCollectionForContentEx4(String format, int pageNumber, String pageModifier, boolean other)	Returns a collection containing the object's content in the repository.
String	IDfFormat.getCOMClassId()	Specifies the Microsoft COM Class ID for a format.
int	IDfWorkflow.getCompleteWitem(int valueIndex)	Returns the number of completed work items for an activity.
IDfId	IDfAssembly.getComponentChronicleId()	Returns the chronicle ID of the component document.
IDfId	IDfPackage.getComponentChronId(int index)	Returns the component chronical id of one of the bound objects.
int	IDfPackage.getComponentChronIdCount()	Returns the number of bound objects in this package.
IDfId	IDfAssembly.getComponentId()	Returns the object ID of the component represented by the assembly object.
IDfId	IDfContainment.getComponentId()	Returns the chronicle ID of the component represented by the containment object.
IDfId	IDfPackage.getComponentId(int index)	Returns the component id of one of the bound objects.
IDfId	IDfSysObject.getComponentId(int index)	Returns the chronicle id of the component documents that make up the virtual document using the computed attribute _componentID.
IDfId	IDfWorkflowAttachment.getComponentId()	Gets the component ID of the bound object.
int	IDfPackage.getComponentIdCount()	Returns the number of bound objects in this package.
int	IDfSysObject.getComponentIdCount()	Returns the number of chronicle IDs of the component documents that make up the virtual document using the computed attribute _componentID.
String	IDfPackage.getComponentName(int index)	Returns the component name, which is typically the object name of the object identified at the corresponding index position in r_component_id
String	IDfWorkflowAttachment.getComponentName()	Returns the component name, which is typically the object name of the object identified in r_component_id.
String	IDfWorkflowAttachment.getComponentType()	Gets the component type, which is the type name of the bound component.
String	IDfSysObject.getCompoundArchitecture()	Used by the virtual document manager to determine if the object can be changed.
int	IDfActivity.getConditionCount()	Returns the number of routing conditions in the activity.
IDfId	IDfActivity.getConditionId()	Returns the object ID of the repository object that stores the route case conditions.
String	IDfActivity.getConditionName(int index)	Returns the name of a route case.
String	IDfActivity.getConditionPort(int index)	Returns the output ports associated with a specified route case.
IDfList	IDfActivity.getConditions(String routeCaseIdentifier)	Returns the list (or list of lists) of transition condition definitions for the named route case.
IDfTypedObject	IDfSession.getConnectionConfig()	Returns the connection config object for a repository session.
String	IDfAssembly.getContainDescription()
IDfId	IDfSysObject.getContainId(int index)	Returns the object id of a containment object that link the component document to its containing virtual document using the computed attribute _containID.
int	IDfSysObject.getContainIdCount()	Returns the number of containment objects IDs that link the component document to its containing virtual document using the computed attribute _containID.
String	IDfAssembly.getContainType()
ByteArrayInputStream	IDfSysObject.getContent()	Copies this object's content from the Documentum server into a ByteArrayInputStream object.
IDfContentAvailability	IDfSysObject.getContentAvailability(String formatName, int pageNumber, String pageModifier, String networkLocationIdentifier)	Returns content availability settings.
ByteArrayInputStream	IDfSysObject.getContentEx(String format, int pageNumber)	Copies this object's content in the repository into a ByteArrayInputStream.
ByteArrayInputStream	IDfSysObject.getContentEx2(String format, int pageNumber, String pageModifier)	Copies this object's content in the repository into a ByteArrayInputStream.
ByteArrayInputStream	IDfSysObject.getContentEx3(String format, int pageNumber, String pageModifier, boolean other)	Copies this object's content in the repository into a ByteArrayInputStream.
IDfCollection	IDfFolder.getContents(String attrNames)	Returns the values of specified attributes for all objects in a folder object.
IDfId	IDfSysObject.getContentsId()	Returns the object id of the content object for an object that has only one content.
int	IDfContentCollection.getContentSize()	Return the size of requested content.
long	IDfSysObject.getContentSize()	Returns the number of bytes in the content.
long	IDfSysObject.getContentSize(int page, String formatName, String pageModifier)	Return the content size according to the page, format and pageModifier of the content
int	IDfSysObject.getContentState(int index)	Returns the state of the content for a given sysobject using the computed attribute _content_state.
int	IDfSysObject.getContentStateCount()	Returns the number of states of a content for the sysobject using the computed attribute _content_state.
String	IDfQueueItem.getContentType()	Returns the file format of the object assciated with a router task.
String	IDfSysObject.getContentType()	Returns the file format of the object's content.
IDfProperties	DfClient.getContext(String contextId)
IDfProperties	IDfClient.getContext(String contextId)	Returns the IDfProperties object associated with a particular client.
int	IDfActivity.getControlFlag()	Returns the control flag attribute of the activity.
String	IDfRelationType.getControllingKind()	Returns the controlling kind attribute defined for the relation of this type.
int	IDfContainment.getCopyBehavior()	Returns the copy behavior defined for the component.
int	IDfRelationType.getCopyBehavior()	Returns the copy behavior defined for the relation of this type.
int	IDfVirtualDocumentNode.getCopyBehavior()	Returns the copy behavior for the node.
String	IDfWorkflow.getCorrelationIdentifier()	Returns value of the 'correlation_identifier' attribute.
IDfTime	IDfSysObject.getCreationDate()	Returns the r_creation_date attribute of the object.
IDfTime	IDfWorkflowAttachment.getCreationDate()	Returns the r_creation_date attribute of the object.
IDfTime	IDfWorkitem.getCreationDate()	Returns the date on which the work item was created.
String	IDfSysObject.getCreatorName()	Returns the name of the creator.
String	IDfWorkflow.getCreatorName()	Returns the name of the person who created the workflow.
String	IDfWorkflowAttachment.getCreatorName()	Returns the name of the creator.
ByteArrayInputStream	IDfContentCollection.getCurrentBuffer()	Returns the current content buffer.
int	IDfContentCollection.getCurrentLength()
int	IDfDumpRecord.getCurrentObjectCount()
String	IDfDumpRecord.getCurrentOffset()
int	IDfDumpRecord.getCurrentPos()
int	IDfDumpRecord.getCurrentRootCount()
int	IDfSysObject.getCurrentState()	Returns the current state.
String	IDfSysObject.getCurrentStateName()	Returns the name of the current state.
IDfTime	IDfQueueItem.getDateSent()	Returns the date the work item, task, or event was sent.
String	IDfSession.getDBMSName()	Returns the name of the RDBMS that underlies the repository identified in the default repository scope.
int	IDfSession.getDefaultACL()	Identifies the default ACL for a Documentum server.
Set<String>	IDfTypeInfo.getDefaultAspects()	Returns a set of name of the default aspects specified in this type and all of its supertypes.
int	IDfVersionPolicy.getDefaultCheckinVersion()	Returns the default checkin version of an object.
String	IDfUser.getDefaultFolder()	Returns the default folder for a user.
IDfId	IDfFormat.getDefaultStorage()
IDfId	IDfTypeInfo.getDefaultStorageId()
String	IDfActivity.getDefinitionState()	Returns the state of the activity definition.
int	IDfPolicy.getDefinitionState()	Return the attribute r_definition_state value.
int	IDfProcess.getDefinitionState()	Returns the state of the workflow definition.
String	IDfQueueItem.getDependencyType()	Returns the dependency type.
int	IDfAssembly.getDepth()	Returns the depth of this component within the top-most virtual document.
String	IDfQueueItem.getDequeuedBy()	Returns the name of the user who dequeued the item.
IDfTime	IDfQueueItem.getDequeuedDate()	Returns the date on which the item was dequeued.
String	IDfACL.getDescription()	Returns the user-defined description of an ACL object.
String	IDfFormat.getDescription()	Retrieves the user-defined description of a format.
String	IDfGroup.getDescription()	Returns the user-defined description of a group object.
String	IDfRelation.getDescription()	Not system defined.Provided for user convenience.
String	IDfRelationType.getDescription()	Returns the user defined description of the relationship.
String	IDfType.getDescription()	Returns the user-defined label for a type.
String	IDfUser.getDescription()	Returns the user-defined description for a user.
String	IDfSysObject.getDirectDescendant()	Returns whether the object has any direct descendants (versions derived directly from this object).
String	IDfValueAssistance.getDisplayValue(String actualValue)	Return the possible display value mapped to the specified actual value.
int	IDfRetainer.getDispositionRule()	Returns the dm_retainer.disposition_rule value.
String	IDfSession.getDMCLSessionId()	Deprecated. use IDfSession.getSessionId() instead.
IDfTypedObject	IDfSession.getDocbaseConfig()	Returns a docbase config object for a repository session.
int	IDfDocbaseMap.getDocbaseCount()	Returns the number of repositories known.
String	IDfDocbaseMap.getDocbaseDescription(int index)	Returns the administrator-defined description of the repository at the specified index.
String	IDfDocbaseMap.getDocbaseId(int index)	Returns the ID of the repository at the specified index.
String	IDfSession.getDocbaseId()	Returns the ID of the repository defined as the default repository scope.
IDfDocbaseMap	DfClient.getDocbaseMap()
IDfDocbaseMap	IDfClient.getDocbaseMap()	Returns information about the repositories that are known to a connection broker.
IDfDocbaseMap	IDfDocbrokerClient.getDocbaseMap()	Returns information about the repositories that are known to the set of connection brokers currently configured for this IDfDocbrokerClient instance.
IDfDocbaseMap	DfClient.getDocbaseMapEx(String protocol, String hostName, String portNumber)
IDfDocbaseMap	IDfClient.getDocbaseMapEx(String protocol, String hostName, String portNumber)	Returns information about the repositories that are known to a connection broker.
IDfDocbaseMap	IDfDocbrokerClient.getDocbaseMapFromSpecificDocbroker(String protocol, String hostName, String portNumber)	Returns information about the repositories that are known to a specific connection broker.
String	IDfDocbaseMap.getDocbaseName(int index)	Returns the name of the repository at the specified index.
String	IDfSession.getDocbaseName()	Returns the name of the repository identified as the default repository scope.
String	DfClient.getDocbaseNameFromDocbaseId(long docbaseId)
String	IDfClient.getDocbaseNameFromDocbaseId(long docbaseId)	Returns the name of the repository with the specified numeric docbase id.
String	IDfDocbrokerClient.getDocbaseNameFromDocbaseId(long docbaseId)	Returns the name of the repository from its numeric id.
String	DfClient.getDocbaseNameFromId(IDfId objectId)
String	IDfClient.getDocbaseNameFromId(IDfId objectId)	Returns the name of the repository from where the object and its IDfId originated.
String	IDfDocbrokerClient.getDocbaseNameFromId(IDfId objectId)	Returns the name of the repository from which the object and its IDfId originated.
String	IDfSession.getDocbaseOwnerName()	Returns the name of the user who owns the repository identified as the default repository scope.
IDfList	IDfDocbaseMap.getDocbaseRoles(int index)
String	IDfSession.getDocbaseScope()	Returns the default repository scope of this session.
IDfTypedObject	DfClient.getDocbrokerMap()
IDfTypedObject	IDfClient.getDocbrokerMap()	Returns information about the connection brokers known to the DFC.
IDfTypedObject	IDfDocbrokerClient.getDocbrokerMap()	Returns information about the connection brokers known to this IDfDocbrokerClient instance.
IDfTypedObject	IDfSession.getDocbrokerMap()	Returns information about the DocBrokers known to the DFC.
String	IDfACL.getDomain()	Returns the domain (owner name) of an ACL.
String	IDfDocbaseMap.getDormancyStatus(int index)	Returns the status of the docbase at the specified index
String	IDfFormat.getDOSExtension()	Retrieves the DOS extension used to copy files of this format into the common area, client local area, and storage.
double	IDfTypedObject.getDouble(String attributeName)	Returns the double value of an attribute.
Double	IDfSysObject.getDoubleContentAttr(String name, String formatName, int page, String pageModifier)	Return a numeric content attribute.
IDfTime	IDfQueueItem.getDueDate()	Returns the date on which the associated work item or task is expected to be completed.
IDfTime	IDfWorkitem.getDueDate()	Returns the work item's due date.
String	IDfDumpRecord.getDumpOperation()
String	IDfDumpRecord.getDumpParameter(int index)
String	IDfDumpRecord.getDumpType(int index)
boolean	IDfGroup.getDynamic()	Gets the dynamic setting of this group
boolean	IDfGroup.getDynamicDefault()	Gets the default membership setting for the dynamic group.
String	IDfSession.getDynamicGroup(int index)	Gets the dynamic group at the specified index from the sessionConfig.
int	IDfSession.getDynamicGroupCount()	Gets the number of dynamic groups that the session user is actively participating as a member of.
IDfTime	IDfRelation.getEffectiveDate()	Not system defined.
IDfTime	IDfDumpRecord.getEndTime()
IDfTime	IDfLoadRecord.getEndTime()
int	IDfRetainer.getEnforcementRule()	Returns the dm_retainer.enforcement_rule value.
String	IDfPolicy.getEntryCriteria(int index)	Get the entry criteria specified by the client for the server to generate a dm_func_expr object and save its ID in the entry_criteria_id attribute for the state with the given index.
IDfId	IDfPolicy.getEntryCriteriaId(int index)	Return the attribute entry_criteria_id value at the specified index.
int	IDfPolicy.getEntryCriteriaIdCount()	Return the number of attribute entry_criteria_id values for this policy.
String	IDfQueueItem.getEvent()	Returns the name of the event.
IDfEventManager	IDfSession.getEventManager()	Retrieves the Event manager for this session.
IDfCollection	IDfSession.getEvents()	Returns all unread items in a user's inbox.
String	IDfPolicy.getExceptionState(int index)	Return the attribute exception_state value at the specified index.
int	IDfPolicy.getExceptionStateCount()	Return the number of attribute exception_state values for this policy.
String	IDfSysObject.getExceptionStateName()	Returns the name of the exception state associated with the current state, if any exist.
int	IDfActivity.getExecErrHandling()	Returns information about how the activity's runtime instance handles execution failure.
IDfId	IDfActivity.getExecMethodId()	Returns the object ID of the method object that executes the activity's actions.
IDfId	IDfPackage.getExecMethodId()	Retrieves the method id of the corresponding workflow object.
String	IDfWorkitem.getExecOsError()	Returns the error string, if any.
IDfId	IDfWorkitem.getExecResultId()	Returns the object ID of the document containing the results of the application's execution.
int	IDfWorkitem.getExecRetriedCount()	Returns value of the r_exec_retried_count attribute.
int	IDfActivity.getExecRetryInterval()	Returns the retry interval if the method execution fails for the activity
int	IDfActivity.getExecRetryMax()	Returns the maximum retry number if the method execution fails for the activity
int	IDfActivity.getExecSubtype()	Returns the exec_subtype attribute of the activity.
int	IDfActivity.getExecTimeOut()	Returns the time-out period, in seconds, for the method that executes the activity's actions.
int	IDfActivity.getExecType()	Returns the execution type of the activity.
IDfTime	IDfRelation.getExpirationDate()	Not system defined.
String	IDfWorkitem.getExtendedPerformer(int valueIndex)	Returns the name of an extended performer.
int	IDfWorkitem.getExtendedPerformerCount()	Returns the number of extended performers for the work item.
IDfId	IDfPolicy.getExtensionObjectId(int index)	Return the IDfId of the extension object for the state indicated by the index proviced.
String	IDfPolicy.getExtensionType()	Return the attribute extension_type value.
int	IDfUser.getFailedAuthenticationAttempts()	Returns the number of failed attempts to authenticate the user.
String	IDfDocbaseMap.getFederationName(int index)	Returns the name of the federation for the repository at the specified index.
String	IDfSysObject.getFile(String fileName)	Retrieves a content file from the Documentum server.
String	IDfSysObject.getFileEx(String fileName, String formatName, int pageNumber, boolean other)	This is the extended method for retreiving a content file from the repository.
String	IDfSysObject.getFileEx2(String fileName, String formatName, int pageNumber, String pageModifier, boolean other)	This is the extended method for retreiving a content file from the repository.
String	IDfDumpRecord.getFileName()
String	IDfFormat.getFilenameModifier()
String	IDfLocation.getFileSystemPath()	Gets the file system path of this location.
String	IDfMountPoint.getFileSystemPath()	Gets the file system path of this mount point.
IDfFolder	IDfSession.getFolderByPath(String folderPath)	Returns a folder object.
IDfFolder	IDfSession.getFolderBySpecification(String folderSpec)	Returns the folder matching the folder specification or null if the folder can not be found.
IDfId	IDfSysObject.getFolderId(int index)	Returns the object id of the folder linked to this object at the given index.
int	IDfSysObject.getFolderIdCount()	Returns the number of folders linked to the object.
String	IDfFolder.getFolderPath(int index)	Returns a folder path to which a folder object is linked.
int	IDfFolder.getFolderPathCount()	Returns the number of folder paths to which a folder object is linked.
boolean	IDfContainment.getFollowAssembly()	Indicates assembly behavior when the component has an associated assembly.
boolean	IDfVirtualDocumentNode.getFollowAssembly()	Returns the follow_assembly attribute setting for this node.
IDfFormat	IDfSession.getFormat(String formatName)	Returns a format object that contains information about the format.
IDfFormat	IDfSysObject.getFormat()	Returns the format of the object.
String	IDfFormat.getFormatClass(int index)
IDfList	IDfWorkitem.getForwardActivities()	Returns a list of IDfActivity interfaces that have at least one input port linked to one of the current activity's output ports.
int	IDfSysObject.getFrozenAssemblyCount()	Returns a count of the number of frozen assemblies that contain the object.
IDfFtConfig	IDfSession.getFtConfig()	Get the fulltext configuration object that contains information about what capabilities the underlying fulltext engine has
long	IDfContentCollection.getFullContentSize()	Return the size of requested content.
IDfDocbaseMap	IDfAdminClient.getFullDocbaseMap()	Returns information about all repositories that are known to a connection broker.
IDfTypedObject	IDfAdminClient.getFullDocbrokerMap()	Returns information about the connection brokers known to the DFC.
IDfTypedObject	IDfAdminClient.getFullServerMap(String docbaseName)	Returns information about the servers that are known to a connection broker.
boolean	IDfSysObject.getFullText()	Returns whether the document is marked for full-text indexing.
String	IDfDocbaseMap.getGoverningDocbase(int index)	Returns the name of the governing repository for the repository at the specified index.
IDfGroup	IDfSession.getGroup(String groupName)	Returns a group object that contains information about the repository group.
String	IDfGroup.getGroupAddress()	Returns the electronic mail address for a group object.
String	IDfGroup.getGroupAdmin()	Gets the admin of this group.
String	IDfGroup.getGroupClass()	Gets the class of this gruop.
int	IDfUser.getGroupDefPermit()	Returns the default group permission assigned to objects created by a user.
IDfId	IDfGroup.getGroupDirectoryId()
String	IDfGroup.getGroupDisplayName()	Gets the display name of a group.
String	IDfGroup.getGroupGlobalUniqueId()
String	IDfGroup.getGroupName()	Returns the name of a group object.
String	IDfSysObject.getGroupName()	Returns the group name to which this object belongs.
IDfId	IDfGroup.getGroupNativeRoomId()	Gets the group native room id.
int	IDfSysObject.getGroupPermit()	Returns the object-level permission assigned to the group for this object.
IDfCollection	IDfGroup.getGroupsNames()	Returns a collection of group members' names in this group.
String	IDfGroup.getGroupsNames(int index)	Returns the name of a group that is a member in a group object at the specified index.
int	IDfGroup.getGroupsNamesCount()	Returns the number of groups that are users in a group object.
String	IDfGroup.getGroupSource()
String	IDfPlugin.getHardwarePlatform()	Gets the hardware platform of this plugin.
boolean	IDfGroup.getHasEvents()
boolean	IDfSysObject.getHasEvents()	Returns whether any users have registered to receive events for the object.
boolean	IDfSysObject.getHasFolder()	Returns whether this object is the CURRENT object in the version tree.
boolean	IDfSysObject.getHasFrozenAssembly()	Returns whether the document's assembly is frozen.
String	IDfUser.getHomeDocbase()	Returns the user's home repository.
String	IDfDocbaseMap.getHostName()	Deprecated. This internal attribute is not meaningful here
String	IDfMountPoint.getHostName()	Gets the host name of this mount point.
int	IDfFormat.getIconIndex()
IDfId	IDfTypedObject.getId(String attributeName)	Returns the ID value of an attribute.
IDfId	IDfSession.getIdByQualification(String qualification)	Returns the ID of a Documentum object that satisfies the DQL qualification.
int	IDfRetainer.getImmutabilityRule()	Returns the dm_retainer.immutability_rule value.
String	IDfSysObject.getImplicitVersionLabel()	Returns the implicit version label from r_version_label.
String	IDfVersionLabels.getImplicitVersionLabel()	Returns the implicit version label associated with the SysObject.
boolean	IDfVirtualDocument.getIncludeBrokenBindings()	Indicates whether nodes with broken bindings are included in the display.
String	IDfPolicy.getIncludedType(int index)	Return the attribute included_type value at the specified index.
int	IDfPolicy.getIncludedTypeCount()	Return the number of attribute included_type values for this policy.
boolean	IDfPolicy.getIncludeSubtypes(int index)	Return the attribute include_subtypes value at the specified index.
int	IDfPolicy.getIncludeSubtypesCount()	Return the number of attribute include_subtypes values for this policy.
String	IDfWorkflow.getInitiateAct()	Returns value of the 'initiate_act' attribute.
int	IDfQueueItem.getInstructionPage()	Returns the instruction page's page number.
String	IDfWorkflow.getInstructions(int index)	Returns the instructions attribute at the specified index.
int	IDfWorkflow.getInstructionsCount()	Returns the number of values the instructions attribute has.
int	IDfTypedObject.getInt(String attributeName)	Returns the integer value of an attribute.
IDfId	IDfQueueItem.getItemId()	Returns the object ID of the package or routed object.
String	IDfQueueItem.getItemName()	Returns the name of the package associated with the work item or router task.
String	IDfQueueItem.getItemType()	Returns the object type of the package or routed object.
boolean	IDfPolicy.getJavaMethods()	Return the attribute java_methods value.
String	IDfSysObject.getKeywords(int index)	Returns the keywords attribute at the specified index.
int	IDfSysObject.getKeywordsCount()	Returns the number of keywords for the object.
IDfCollection	IDfSession.getLastCollection()	Returns the collection object for the most recently executed query.
String	IDfWorkflow.getLastPerformer(int valueIndex)	Returns the name of the performer who most recently completed a work item for a particular activity.
IDfId	IDfWorkflow.getLastWitemId(int valueIndex)	Returns the object ID of the most recently completed work item for a particular activity.
String	IDfVirtualDocumentNode.getLateBindingValue()	Returns the late binding value for the node.
boolean	IDfSysObject.getLatestFlag()	Indicates whether this version is the most recent version of the object on a particular branch in the version tree.
IDfTime	IDfWorkitem.getLaunchTimeout()	Returns the launch timeout value of this work item.
com.documentum.fc.client.license.ILicenseManager	DfClient.getLicenseManager()
com.documentum.fc.client.license.ILicenseManager	IDfClient.getLicenseManager()
int	IDfSysObject.getLinkCount()	Returns the number of objects linked to the object.
String	IDfProcess.getLinkDestActivity(int linkIndex)	Returns a link's destination activity.
String	IDfProcess.getLinkDestPort(int linkIndex)	Returns a link's destination port.
int	IDfSysObject.getLinkHighCount()	Returns the current maximum order number assigned to a component.
String	IDfProcess.getLinkName(int linkIndex)	Returns a link name.
String	IDfProcess.getLinkSrcActivity(int linkIndex)	Returns a link's source activity.
String	IDfProcess.getLinkSrcPort(int linkIndex)	Returns a link's source port.
String	IDfLoadRecord.getLoadFileName()
String	IDfLoadRecord.getLoadOperation()
String	IDfLoadRecord.getLoadParameter(int index)
String	IDfLoadRecord.getLoadType(int index)
static IDfClient	DfClient.getLocalClient()	Returns the IDfClient interface for a singleton instance of DfClient.
static IDfClient	DfClient.getLocalClient32()	Deprecated. Please use DfClient.getLocalClient() instead
IDfCollection	IDfSysObject.getLocations(String attrNames)	Runs a query to find all the places this object is used and returns the query result as a collection.
IDfTime	IDfSysObject.getLockDate()	Returns the date this object was locked.
String	IDfSysObject.getLockMachine()	Returns the name of the client machine on which the object was locked.
String	IDfSysObject.getLockOwner()	Returns the name of the user who locked the object.
String	IDfVersionPolicy.getLogComment()	Returns the log entry for an object.
String	IDfSysObject.getLogEntry()	Returns the comment specified by the user.
IDfLoginInfo	IDfSession.getLoginInfo()	Returns a copy of the login information used to establish this DFC session.
String	IDfSession.getLoginTicket()	Returns a new ticket based on the current session login information.
String	DfClient.getLoginTicketDiagnostics(String loginTicket)
String	IDfClient.getLoginTicketDiagnostics(String loginTicket)	Return details extracted from a login ticket.
String	IDfSession.getLoginTicketEx(String userLoginName, String scope, int timeout, boolean singleUse, String serverName)	Returns a new ticket based on the current session login information.
String	IDfSession.getLoginTicketForUser(String userName)	Returns a ticket for a specific user.
String	IDfSession.getLoginUserName()	Returns the repository name of the current user.
long	IDfTypedObject.getLong(String attributeName)	Returns the long integer value of an attribute.
String	IDfFormat.getMacCreator()	Retrieves the Macintosh creator to use for a format.
String	IDfMountPoint.getMacPreferredAlias()	Gets the Macintosh preferred alias of this mount point.
String	IDfFormat.getMacType()	Retrieves the Macintosh type to use for a format.
String	IDfSysObject.getMasterDocbase()	Returns the repository id of the repository that owns the object using the computed attribute _master_docbase.
String	IDfQueueItem.getMessage()	Returns the message associated with the work item, task, or event notification.
String	IDfSession.getMessage(int severityLevel)	Returns all messages from an established session at or above a specified severity level.
String	IDfMethodObject.getMethodArgs(int index)
String	IDfMethodObject.getMethodContent()	Gets the content of the method.
String	IDfMethodObject.getMethodType()
String	IDfMethodObject.getMethodVerb()
String	IDfFormat.getMIMEType()	Specifies the MIME (Multimedia Internet Mail Extension) type to use for a format.
IDfCollection	IDfWorkitem.getMissingOutputPackages()	Returns a collection whose result objects describe all output ports in the work item that don't have a package.
String	IDfSysObject.getModifier()	Returns the name of the user who made the last modification.
IDfTime	IDfGroup.getModifyDate()	Returns the time and date that a group object was last modified.
IDfTime	IDfSysObject.getModifyDate()	Returns the r_modify_date attribute of the object.
IDfTime	IDfUser.getModifyDate()	Returns the time and date that a user was last modified.
Class	DfClient.getModuleClass(String moduleName, IDfSession session)
IDfModuleDescriptor	IDfLocalModuleRegistry.getModuleDescriptor(String moduleName)	Gets the meta data for the service mapped to the service name, if found.
IDfEnumeration	IDfLocalModuleRegistry.getModuleDescriptors()	Get a list of all modules available.
IDfGlobalModuleRegistry	DfClient.getModuleRegistry()
IDfGlobalModuleRegistry	IDfClient.getModuleRegistry()	Factory method that instantiates an IDfGlobalModuleRegistry global module registry object.
IDfLocalModuleRegistry	IDfSession.getModuleRegistry()	Factory method that instantiates an IDfLocalModulesRegistry, a repository module registry object.
String	IDfLocation.getMountPointName()	Gets the mount point name of this location.
String	IDfFormat.getName()	Retrieves the format name.
String	IDfQueueItem.getName()	Returns the name of the queue owner.
String	IDfType.getName()	Returns a type's name.
IDfNetworkLocationEntry	DfClient.getNetworkLocation(String locationId, String locale)
IDfNetworkLocationEntry	IDfClient.getNetworkLocation(String locationId, String locale)	Deprecated. use IDfAcsClient.getNetworkLocation()
IDfList	IDfWorkitem.getNextActivityNames()	Retrieves all activities that immediately follow this work item.
String	IDfVersionPolicy.getNextMajorLabel()	Returns the next major implicit version label for an object.
String	IDfVersionPolicy.getNextMinorLabel()	Returns the next minor implicit version label for an object.
int	IDfWorkflow.getNextSeqno()	Returns the next sequence number in the workflow.
String	IDfSysObject.getNextStateName()	Returns the name of the next state.
String	IDfQueueItem.getNextTasksType()	Indicates which tasks in the "next tasks list" are queued when this task is forwarded.
IDfVirtualDocumentNode	IDfVirtualDocument.getNodeFromNodeId(IDfId nodeId)	Returns the IDfVirtualDocumentNode interface for the node corresponding to a given node ID.
String	IDfVDMNumberingScheme.getNodeNumber(IDfVirtualDocumentNode node)	Returns the hierarchy number of a virtual document component.
String	IDfVirtualDocumentNode.getNodeToken()	Returns a string representation of the virtual document node in a particular format.The format corresponds to the virtual document node's position with respect to the root.
int	IDfPackage.getNoteCount()	Returns the number of notes in this package.
IDfTime	IDfPackage.getNoteCreationDate(int noteIndex)	Returns an IDfTime interface which contains the creation date of the specified note.
int	IDfPackage.getNoteFlag(int noteIndex)	Returns the special flags for a note.
IDfId	IDfPackage.getNoteId(int noteIndex)	Returns the object id of the dm_note object.
boolean	IDfPackage.getNotePersistance(int noteIndex)	Returns a boolean value to indicate whether the note is persistent across all activities.
String	IDfPackage.getNoteText(int noteIndex)	Returns a String containing the content of the specified note.
String	IDfPackage.getNoteWriter(int noteIndex)	Returns the name of the user who wrote the note.
IDfVDMNumberingScheme	IDfVirtualDocument.getNumberingScheme()	Returns the numbering scheme for the virtual document.
IDfPersistentObject	IDfSession.getObject(IDfId objectId)	Returns a Documentum server object.
IDfPersistentObject	IDfSession.getObjectByPath(String objectPath)	Returns a Documentum server object given a full path to the object.
IDfPersistentObject	IDfSession.getObjectByQualification(String qualification)	Returns a Documentum server object that satisfies the DQL qualification.
IDfPersistentObject	IDfSession.getObjectByQualificationWithInterface(String qualification, String interfaceName)	Deprecated. Please use Aspects instead for interface extension.
String	IDfAliasSet.getObjectDescription()	Returns the description of the alias set.
IDfId	IDfTypedObject.getObjectId()	Returns the ID of this object.
IDfId	IDfVersionLabels.getObjectId()	Returns the object ID of the SysObject.
IDfId	IDfVersionTreeLabels.getObjectIdFromVersionLabel(String label)	Returns the object ID of the object carrying a given version label.
IDfPersistentObject	IDfLightObject.getObjectImpl()	Retrieves an interface to the current object implementation.
String	IDfACL.getObjectName()	Returns the ACL name.
String	IDfAliasSet.getObjectName()	Returns the name of this alias set.
String	IDfSysObject.getObjectName()	Returns the object_name attribute of the object.
String	IDfWorkflow.getObjectName()	Returns the name of the workflow object.
IDfEnumeration	IDfSession.getObjectPaths(IDfId objectId)	Generate IDfEnumeration object of IDfObjectPath objects for an object with a given object id.

Uses of DfException in com.documentum.fc.client.acs

Methods in com.documentum.fc.client.acs that throw DfException

Modifier and Type	Method	Description
void	IDfBocsConfig.addExternalUrlEntry(IDfBocsConfig.ExternalUrlEntry urlEntry)	Adds ExternalUrlEntry object.
void	IDfAcsConfig.addProjectionEntry(IDfAcsConfig.ProjectionEntry projectionEntry)	Adds ProjectionEntry object.
void	IDfAcsConfig.addStoreEntry(IDfAcsConfig.StoreEntry storeEntry)	Adds StoreEntry object.
void	IDfAcsClient.addUnavailableAcsServer(String urlString)	Add the specified accelerated content store (ACS) server to the list of unavailable ACS servers.
void	IDfAcsConfig.addUrlEntry(IDfAcsConfig.UrlEntry urlEntry)	Adds UrlEntry object.
void	IDfBocsConfig.addUrlEntry(IDfBocsConfig.UrlEntry urlEntry)	Adds UrlEntry object.
IDfEnumeration	IDfAcsClient.getAcsData(IDfSessionManager sessionManager, String docbaseName, String networkLocationIdentifier)	Returns an IDfEnumeration object that lists all AcsData objects for a given repository.
IDfEnumeration	IDfAcsClient.getAcsData(IDfSession session, String networkLocationIdentifier)	Returns an IDfEnumeration object that lists all AcsData objects for a given repository.
IDfList	IDfAcsConfig.getAcsNetworkLocationIdentifiers()	Returns a list of the ACS network location identifiers.
IDfEnumeration	IDfAcsClient.getAllNetworkLocations(String locale)	Returns an IDfEnumeration object that lists all IDfNetworkLocationEntry objects.
String	IDfContentTransferConfig.getBocsEncryptionMode()	Returns BOCS encryption mode in this repository.
IDfEnumeration	IDfAcsClient.getClientNetworkLocations(String clientIPAddress, String locale)	Returns an IDfEnumeration object that lists all IDfNetworkLocationEntry objects.
int	IDfAcsConfig.getConfigType()	Returns type of the config.
String	IDfBocsConfig.getDeliveryType()	Returns the delivery type
String	IDfValidationDescriptor.getDescriptorVersion()	Returns the descriptor version as major.minor
IDfList	IDfBocsConfig.getDocbaseNames()	Returns list of the repository names.
String	IDfAcsConfig.getDormancyStatus()	Gets the dormancy status for this ACS
String	IDfContentTransferConfig.getEffectiveBocsEncryptionMode()	Returns BOCS encryption mode in this repository.
IDfList	IDfBocsConfig.getExternalUrlEntries()	Returns list of ExternalUrlEntry objects.
String	IDfDmsConfig.getMessageConsumeUrl()	Returns URL that can be used by agents to consume messages from DMS in a pull mode
String	IDfDmsConfig.getMessagePostUrl()	Returns URL that can be used to post messages to DMS
IDfList	IDfAcsConfig.getNearStores()	Returns list of names of stores that are near the ACS.
IDfNetworkLocationEntry	IDfAcsClient.getNetworkLocation(String locationId, String locale)	Returns an IDfNetworkLocationEntry object by location identifier.
IDfList	IDfBocsConfig.getNetworkLocationIdentifiers()	Returns list of the BOCS network location identifiers.
String	IDfAcsConfig.getObjectName()	Returns the ACS name.
String	IDfBocsConfig.getObjectName()	Returns the BOCS name.
String	IDfValidationDescriptor.getObjectName()	Returns the descriptor name.
IDfList	IDfValidationDescriptor.getParameterNames()	Returns the list of parameter names
IDfList	IDfAcsConfig.getProjectionEntries()	Returns list of ProjectionEntry objects.
int	IDfAcsConfig.getRWCapability()	Deprecated. use isEnabled and isSurrogateGetEnabled methods
IDfId	IDfAcsConfig.getServerConfigId()	Returns the ID of the Content Server config object for the ACS.
String	IDfAcsConfig.getServerMajorVersion()	Returns server major version
String	IDfBocsConfig.getServerMajorVersion()	Returns server major version
String	IDfDmsConfig.getServerMajorVersion()	Returns server major version
String	IDfAcsConfig.getServerMinorVersion()	Returns the server minor version
String	IDfBocsConfig.getServerMinorVersion()	Returns the server minor version
String	IDfDmsConfig.getServerMinorVersion()	Returns the server minor version
IDfList	IDfAcsConfig.getStoreEntries()	Returns list of StoreEntry objects.
IDfList	IDfAcsConfig.getUrlEntries()	Returns list of UrlEntry objects.
IDfList	IDfBocsConfig.getUrlEntries()	Returns list of UrlEntry objects.
boolean	IDfContentTransferConfig.isAcsAsynchWriteEnabled()	Returns whether ACS asynchronous write mode is enabled in this repository.
boolean	IDfContentTransferConfig.isAcsReadEnabled()	Returns whether ACS read mode is enabled in this repository.
boolean	IDfContentTransferConfig.isAcsWriteEnabled()	Returns whether ACS write mode is enabled in this repository.
boolean	IDfBocsConfig.isAsynchWriteEnabled()	Returns a flag indicating whether asynchronous write is enabled
boolean	IDfContentTransferConfig.isBocsPrecachingEnabled()	Returns whether BOCS predictive caching is enabled in this repository.
boolean	IDfAcsConfig.isCacheAcs()	Deprecated. as of version D6, use IDfBocsConfig for cache server config objects.
boolean	IDfAcsClient.isContentTransferCapabilityEnabled(IDfSession session, String networkLocationIdentifier, IDfContentTransferCapability capability)	Returns whether content transfer capability is enabled in a docbase of a given session.
boolean	IDfAcsConfig.isEnabled()	Returns a flag indicating whether ACS is enabled
boolean	IDfBocsConfig.isEnabled()	Returns a flag indicating whether BOCS is enabled
boolean	IDfDmsConfig.isEnabled()	Returns whether DMS is enabled.
boolean	IDfBocsConfig.isInclusionList()	Returns a flag indicating whether the list of repositories is an inclusion list.
boolean	IDfAcsConfig.isSurrogateGetEnabled()	Returns a flag indicating whether both read and a "surrogate get" is enabled
IDfBocsConfig.ExternalUrlEntry	IDfBocsConfig.newExternalUrlEntry(String url, String type)	Creates ExternalUrlEntry object.
IDfAcsConfig.ProjectionEntry	IDfAcsConfig.newProjectionEntry(String networkLocationIdentifier, int proximity)	Creates ProjectionEntry object.
IDfAcsConfig.ProjectionEntry	IDfAcsConfig.newProjectionEntry(String host, int port, int proximity)	Creates ProjectionEntry object.
IDfAcsConfig.ProjectionEntry	IDfAcsConfig.newProjectionEntry(String host, int port, int proximity, boolean isEnabled, String networkLocationIdentifier, boolean isNetworkLocationEnabled)	Creates ProjectionEntry object.
IDfAcsConfig.StoreEntry	IDfAcsConfig.newStoreEntry(int storeType, int cryptoMode, int compressionMode)	Creates StoreEntry object.
IDfAcsConfig.UrlEntry	IDfAcsConfig.newUrlEntry(String url, String protocol)	Creates UrlEntry object.
IDfBocsConfig.UrlEntry	IDfBocsConfig.newUrlEntry(String url, String protocol)	Creates UrlEntry object.
void	IDfAcsConfig.setAcsNetworkLocationIdentifiers(IDfList acsNetworkLocationIdentifiers)	Sets the ACS network location identifiers.
void	IDfContentTransferConfig.setAcsReadEnabled(boolean isEnabled)	Sets whether ACS read mode is enabled in this repository.
void	IDfContentTransferConfig.setAcsWriteMode(String mode)	Sets ACS write mode in this repository.
void	IDfBocsConfig.setAsynchWriteEnabled(boolean isEnabled)	Sets a flag indicating whether asynchronous write is enabled.
void	IDfContentTransferConfig.setBocsEncryptionMode(String mode)	Sets BOCS encryption mode in this repository.
void	IDfContentTransferConfig.setBocsPrecachingEnabled(boolean isEnabled)	Sets whether BOCS predictive caching is enabled in this repository.
void	IDfAcsConfig.setCacheAcs(boolean isCacheAcs)	Deprecated. as of version D6, use IDfBocsConfig for cache server config objects.
void	IDfAcsConfig.setConfigType(int configType)	Sets type of the config.
void	IDfBocsConfig.setDeliveryType(String deliveryType)	Sets the delivery type
void	IDfValidationDescriptor.setDescriptorVersion(String version)	Sets the descriptor version
void	IDfBocsConfig.setDocbaseNames(IDfList docbaseNames)	Sets the repository names.
void	IDfAcsConfig.setEnabled(boolean isEnabled)	Sets a flag indicating whether ACS is enabled
void	IDfBocsConfig.setEnabled(boolean isEnabled)	Sets a flag indicating whether BOCS is enabled
void	IDfDmsConfig.setEnabled(boolean isEnabled)	Sets whether DMS is enabled.
void	IDfBocsConfig.setExternalUrlEntries(IDfList urlEntries)	Replace all ExternalUrlEntry objects.
void	IDfBocsConfig.setInclusionList(boolean isInclusionList)	Sets a flag indicating whether the list of repositories is an inclusion list.
void	IDfDmsConfig.setMessageConsumeUrl(String url)	Sets URL that can be used by agents to consume messages from DMS in a pull mode
void	IDfDmsConfig.setMessagePostUrl(String url)	Sets URL that can be used to post messages to DMS
void	IDfAcsConfig.setNearStores(IDfList nearStores)	Sets list of names of stores that are near the ACS.
void	IDfBocsConfig.setNetworkLocationIdentifiers(IDfList networkLocationIdentifiers)	Sets the BOCS network location identifiers.
void	IDfAcsConfig.setObjectName(String objectName)	Sets the ACS name.
void	IDfBocsConfig.setObjectName(String objectName)	Sets the BOCS name.
void	IDfValidationDescriptor.setObjectName(String descriptorName)	Sets the descriptor name.
void	IDfValidationDescriptor.setParameterNames(IDfList parameterNames)	Sets the list of parameter names
void	IDfAcsConfig.setProjectionEntries(IDfList projectionEntries)	Replace all ProjectionEntry objects.
void	IDfAcsConfig.setRWCapability(int capability)	Deprecated. use setEnabled and setSurrogateGetEnabled methods
void	IDfAcsConfig.setServerConfigId(IDfId serverConfigId)	Sets the ID of the Content Server config object for the ACS.
void	IDfAcsConfig.setServerMajorVersion(String majorVersion)	Sets server major version
void	IDfBocsConfig.setServerMajorVersion(String majorVersion)	Sets server major version
void	IDfDmsConfig.setServerMajorVersion(String majorVersion)	Sets server major version
void	IDfAcsConfig.setServerMinorVersion(String minorVersion)	Sets the server minor version
void	IDfBocsConfig.setServerMinorVersion(String minorVersion)	Sets the server minor version
void	IDfDmsConfig.setServerMinorVersion(String minorVersion)	Sets the server minor version
void	IDfAcsConfig.setStoreEntries(IDfList storeEntries)	Replaces all StoreEntry objects.
void	IDfAcsConfig.setSurrogateGetEnabled(boolean isEnabled)	Sets a flag indicating whether both read and a "surrogate get" is enabled.
void	IDfAcsConfig.setUrlEntries(IDfList urlEntries)	Replaces all UrlEntry objects.
void	IDfBocsConfig.setUrlEntries(IDfList urlEntries)	Replace all UrlEntry objects.

Uses of DfException in com.documentum.fc.client.aspect

Methods in com.documentum.fc.client.aspect that throw DfException

Modifier and Type	Method	Description
void	IDfAspects.attachAspect(String name, IDfAttachAspectCallback callback)	Attaches the named aspect and invokes the optional callback when the object is completely rebuilt.
void	IDfAspects.detachAspect(String name, IDfDetachAspectCallback callback)	Detaches the named aspect and invokes the optional callback when the object is completely rebuilt.
IDfList	IDfAspects.getAspects()	Returns a list of the names of all attached aspects.

Uses of DfException in com.documentum.fc.client.content

Subclasses of DfException in com.documentum.fc.client.content

Modifier and Type	Class	Description
class	DfContentTemporarilyUnavailableException	This exception is thrown when content has not been stored in a docbase yet.

Uses of DfException in com.documentum.fc.client.fulltext

Methods in com.documentum.fc.client.fulltext that throw DfException

Modifier and Type	Method	Description
boolean	IDfFtConfig.isCapabilitySupported(IDfFtConfig.FtCapability capability)	Checks if the given capability is supported by the underlying fulltext engine.

Uses of DfException in com.documentum.fc.client.search

Subclasses of DfException in com.documentum.fc.client.search

Modifier and Type	Class	Description
class	DfConfigurationException	This exception is thrown in case of a possible configuration issue of the ECIS adpaters when doing a search.
class	DfQueryFormatException	This exception is thrown when format of a stored query cannot be recognized.
class	DfQueryGenerationException	This exception is thrown when unexpected condition is discovered during query generation process.
class	DfResultContentException	This exception is thrown during the retrieval of a result content.
class	DfSearchException	This exception is a base exception for the com.documentum.fc.client.search package.
class	DfSearchLoginException	This exception is thrown when credentials are invalid.
class	DfUnreachableLocationException	This exception is thrown when the target location is unreachable.

Methods in com.documentum.fc.client.search that return DfException

Modifier and Type	Method	Description
DfException	IDfQueryEvent.getException()	In case of an error, this method may return the actual exception that occurs with the source.

Methods in com.documentum.fc.client.search that throw DfException

Modifier and Type	Method	Description
void	IDfExpression.acceptVisitor(DfExpressionVisitor visitor)	Visits this expression.
IDfLocationQueryScope	IDfQueryBuilder.addLocationScope(String source, IDfId locationId, boolean isDescend, boolean isExcluded)	Adds a location scope.
IDfLocationQueryScope	IDfQueryBuilder.addLocationScope(String source, String locationPath, boolean isDescend)	Adds a location scope.
IDfLocationQueryScope	IDfQueryBuilder.addLocationScope(String source, String locationPath, boolean isDescend, boolean isExcluded)	Adds a location scope.
IDfPartitionScope	IDfQueryBuilder.addPartitionScope(String source, String partitionName)	Adds a partition scope.
void	IDfSearchSourceContainer.addSelectedSource(String sourceName)	Adds a selected source.
boolean	IDfSmartList.areResultsSaved()	Checks whether results are saved or not with the search.
void	IDfSearchSourceContainer.clearSelectedSources()	Removes all selected sources.
String	IDfSearchMetadataManager.convertDocbaseToMimeFormat(String docbaseFormat)	Converts a repository format value to MIME format value.
String	IDfSearchMetadataManager.convertMimeToDocbaseFormat(String mimeFormat)	Converts a MIME format value to repository format value.
IDfSmartListDefinition	IDfQueryManager.convertSmartListDefinition(IDfSysObject oldSmartList)	Converts smart list definition using a legacy dm_smartlist object.
IDfSmartListDefinition	IDfSmartListDefinition.copy()	Performs a deep copy of this instance.
IDfSmartList	IDfSearchStoreService.createSearch(String name, String description, IDfSmartListDefinition smartListDefinition, IDfResultsSet resultSet, IDfQueryStatus queryStatus)	Creates a new search prior to storing it.
boolean	IDfSearchStoreService.existsSearch(String objectName, boolean inMySearches, String folderId)	Checks whether a search with the same name already exists in the database.
IDfCollection	IDfSearchStoreService.getAllSearches()	Deprecated. Use getAllSearches(IDfSession) instead
IDfCollection	IDfSearchStoreService.getAllSearches(IDfSession session)	Returns all searches from this repository, including all of the user's searches and any shared searches.
IDfPersistentObject	IDfResultObjectManager.getAsPersistentObject(IDfResultEntry entry)	Gets the IDfTypedObject corresponding to the result.
int	IDfSearchTypeAssistant.getAttrDataType(String attrName)	Retrieves the datatype of an attribute.
String	IDfSearchTypeAssistant.getAttributeLabel(String attrName)	Retrieves a localized attribute label for a given attribute.
IDfEnumeration	IDfSearchTypeAssistant.getAttributeNames()	Retrieves an enumeration of the names of the searchable attributes for the type.
int	IDfSearchSourceMap.getAvailableSourceCount()	Gets the count of available sources.
IDfEnumeration	IDfSearchSourceMap.getAvailableSources()	Provides access to an enumeration of all available sources.
IDfEnumeration	IDfSearchSourceMap.getAvailableSources(int sourceType)	Provides access to an enumeration of available sources of a given type.
IDfEnumeration	IDfSearchMetadataManager.getAvailableTypes()	Provides an enumeration of available searchable types.
IDfEnumeration	IDfSearchMetadataManager.getAvailableTypes(boolean includeObsoleteTypes)	Provides an enumeration of available searchable types derived from a specified base type.
IDfEnumeration	IDfSearchMetadataManager.getAvailableTypes(String baseType)	Provides an enumeration available types derived from a specified base type.
IDfEnumeration	IDfSearchMetadataManager.getAvailableTypes(String baseType, boolean includeObsoleteTypes)	Provides an enumeration available types derived from a specified base type.
IDfResultContent	IDfResultObjectManager.getContent(IDfResultEntry entry)	Gets the content corresponding to the result.
String	IDfModifiableResultEntry.getContentDescriptor()	Gets the descriptor of an external result content.
IDfCollection	IDfSearchStoreService.getCurrentUserSearches()	Deprecated. Use getCurrentUserSearches(IDfSession) instead
IDfCollection	IDfSearchStoreService.getCurrentUserSearches(IDfSession session)	Returns only the user's searches from this repository.
String	IDfSearchTypeAssistant.getDefaultAttribute()	Provides access to a default attribute for the type.
String	IDfSearchTypeAssistant.getDefaultSearchOp(String attrName)	Retrieves the default search operation as a string code (such as "10", "1", ...) for an attribute.
String	IDfSearchTypeAssistant.getDefaultValue(String attrName)	Retrieves the default search value for the specified attribute.
String	IDfSearchTypeAssistant.getDefaultValue(String attrName, String searchOp)	Deprecated.
String	IDfResultContent.getDOSExtension()	Gets the default DOS extension corresponding to the content type.
IDfList	IDfSearchMetadataManager.getDOSExtensions(String mimeFormat)	Gets the DOS extensions associated to the specified MIME format value in the repository.
InputStream	IDfResultContent.getInputStream()	Gets an InputStream to the content.
IDfObjectPath	IDfLocationQueryScope.getLocationPath()	Gets the location path.
String	IDfSearchMetadataManager.getMetadataDocbase()	Gets the repository to pick the metadata information from information on types.
String	IDfResultContent.getMIMEType()	Gets the MIME type of the content.
IDfId	IDfResultObjectManager.getObjectId(IDfResultEntry entry)	Gets the object ID of the object corresponding to the result.
String	IDfSmartList.getQueryDefinitionType()	Gets the Query definition type.
IDfQueryStatus	IDfSmartList.getQueryStatus()	Gets the IDfQueryStatus.
IDfResultEntry	IDfResultsSet.getResultByKey(String key)	Gets the result that is represented by the specified String key.
int	IDfSmartList.getResultsCount()	Gets the number of results for the search.
IDfResultsSet	IDfSmartList.getResultsSet()	Gets the IDfResultsSet.
String	IDfSearchTypeAssistant.getSearchOpLabel(String attrName, String searchOp)	Retrieves a localized search operation label (such as "Greater than", "Equal", ...) for a given search operation code.
IDfEnumeration	IDfSearchTypeAssistant.getSearchOpLabels(String attrName)	Retrieves an enumeration of the localized search operation labels (such as "Greater than", "Equal", ...).
IDfEnumeration	IDfSearchTypeAssistant.getSearchOps(String attrName)	Retrieves an enumeration of search operations as string codes (such as "10", "1", ...).
int	IDfResultContent.getSize()	Gets the size of the content.
IDfSmartListDefinition	IDfSmartList.getSmartListDefinition(IDfSearchService searchService)	Gets the IDfSmartListDefinition associated to this dm_smart_list.
IDfSearchSource	IDfSearchSourceMap.getSource(String sourceName)	Provides access to an individual source.
String	IDfSearchTypeAssistant.getSuperName()	Gets the super-type name.
String	IDfResultContent.getType()	Gets the content type of the content.
IDfType	IDfSearchTypeAssistant.getType()	Returns a read only copy of IDfType object disconnected from the current session.
IDfSearchTypeAssistant	IDfSearchMetadataManager.getTypeAssistant(String typeName)	Provides access to a type assistant for the given type.
IDfSearchTypeAssistant	IDfSearchMetadataManager.getTypeAssistant(String typeName, boolean includeObsoleteTypes)	Provides access to a type assistant for the given type.
String	IDfSearchTypeAssistant.getTypeLabel()	Gets the type label.
String	IDfResultObjectManager.getURL(IDfResultEntry entry)	Gets the URL where the result's content can be accessed.
IDfValueAssistance	IDfSearchTypeAssistant.getValueAssistance(IDfExpression rootExpr, IDfAttrExpression vaExpr)	Gets the value assistance of an attribute with dependencies to other attributes values.
IDfValueAssistance	IDfSearchTypeAssistant.getValueAssistance(String attrName)	Gets the value assistance of an attribute without dependencies to other attributes values.
String	IDfSearchTypeAssistant.getValueLabel(String attrName, String searchOp, String value)	Deprecated.
IDfEnumeration	IDfSearchTypeAssistant.getValues(String attrName, String searchOp)	Deprecated.
boolean	IDfSearchTypeAssistant.hasAttribute(String attribute)	Checks if an attribute is available on the type. An attribute name may be available on a type, even if it does not appear in the enumeration of getAttributeNames(): Aspect attributes: they are not part of the type, but they may be supported by the type (and in queries) Non searchable attributes: getAttributeNames() returns only the searchable attributes.
boolean	IDfSearchTypeAssistant.hasValueAssistance(String attrName)	Indicates whether a value assistance is available for an attribute.
boolean	IDfSearchTypeAssistant.hasValueAssistanceDependencies(String attrName)	Indicates whether the value assistance of an attribute defines dependencies on other attributes values.
boolean	IDfSearchTypeAssistant.isAttributeRepeated(String attrName)	Tests if a given attribute is repeated.
boolean	IDfSmartList.isLegacy()	Indicates whether this smart list is an old format.
boolean	IDfResultObjectManager.isRepositoryObject(IDfResultEntry entry)	Indicates whether the result comes from a repository and can be accessed as a IDfSysObject.
boolean	IDfResultObjectManager.isURLAdressible(IDfResultEntry entry)	Indicates if the result's content is accessible directly through a URL.
IDfQueryDefinition	IDfQueryManager.loadQueryDefinition(InputStream in)	Loads a query definition from a stream.
IDfSmartList	IDfSearchStoreService.loadSearch(String ObjectId)	Gets a Search (before a load) using the ID.
IDfSmartListDefinition	IDfQueryManager.loadSmartListDefinition(InputStream in)	Loads a smart list definition from a stream.
IDfSmartListDefinition	IDfQueryManager.loadSmartListDefinition(Document doc, Node parentNode)	Loads a smart list definition from an XML document node.
IDfPassThroughQuery	IDfQueryManager.newPassThroughQuery(String queryString)	Creates a new pass-through query using the specified parameters.
IDfPassThroughQuery	IDfQueryManager.newPassThroughQuery(String queryString, String customQueryData, int maxResultCount)	Creates a new pass-through using the specified parameters.
IDfQueryBuilder	IDfQueryManager.newQueryBuilder()	Creates a new query builder.
IDfQueryBuilder	IDfQueryManager.newQueryBuilder(String objectType)	Creates a new query builder using the specified object type.
IDfQueryBuilder	IDfQueryManager.newQueryBuilder(String objectType, int maxResultCount, boolean isDatabaseSearchRequested)	Creates a new query builder using the specified parameters.
IDfSmartListDefinition	IDfQueryManager.newSmartListDefinition()	Creates a new smart list definition.
void	IDfSearchSourceContainer.removeSelectedSource(String sourceName)	Removes selected source.
String	IDfSmartList.save(String location, boolean withResults, boolean isPrivate)	Stores this search.
void	IDfQueryManager.saveQueryDefinition(IDfQueryDefinition queryDefinition, OutputStream out)	Saves a query definition in an output stream.
void	IDfQueryManager.saveSmartListDefinition(IDfSmartListDefinition smartList, OutputStream out)	Saves a smart list definition in an output stream.
void	IDfQueryManager.saveSmartListDefinition(IDfSmartListDefinition smartList, Document doc, Node parentNode)	Saves a smart list definition in an output stream.
void	IDfModifiableResultEntry.setContentDescriptor(String contentDescriptor)	Sets the descriptor of an external result content.
void	IDfSearchResults.setResultsSet(IDfResultsSet resultSet)	Sets the IDfResultsSet.
void	IDfSmartList.setResultsSet(IDfResultsSet resultSet)	Sets the IDfResultsSet.
void	IDfSmartList.setSmartListDefinition(IDfSmartListDefinition smartList)	Sets the content of this dm_smart_list.
boolean	IDfSearchStoreService.supportsResultsStorage()	Checks whether the new store search attributes are available in the repository.
void	DfExpressionVisitor.visit(IDfExpressionSet expr)	Visits an IDfExpressionSet.
void	DfExpressionVisitor.visit(IDfFullTextExpression expr)	Visits an IDfFullTextExpression.
void	DfExpressionVisitor.visit(IDfRelativeDateExpression expr)	Visits an IDfRelativeDateExpression.
void	DfExpressionVisitor.visit(IDfSimpleAttrExpression expr)	Visits an IDfSimpleAttrExpression.
void	DfExpressionVisitor.visit(IDfValueListAttrExpression expr)	Visits an IDfValueListAttrExpression.
void	DfExpressionVisitor.visit(IDfValueRangeAttrExpression expr)	Visits an IDfValueRangeAttrExpression.

Uses of DfException in com.documentum.fc.client.search.filter

Subclasses of DfException in com.documentum.fc.client.search.filter

Modifier and Type	Class	Description
class	DfFilterException	An exception raised by a filter.

Methods in com.documentum.fc.client.search.filter that throw DfException

Modifier and Type	Method	Description
List<IDfModifiableFacet>	IDfFacetFilter.filterFacets(IDfContext context, List<IDfModifiableFacet> facets)	This method can potentially be called multiple time for a query.
IDfQueryDefinition	IDfQueryFilter.filterQuery(IDfContext context, IDfQueryDefinition query)
List<IDfModifiableResultEntry>	IDfResultFilter.filterResults(IDfContext context, List<IDfModifiableResultEntry> resultsBatch)	This method can be called several times per query
IDfGenerationContext.Language	IDfGenerationContext.getTargetLanguage()	Indicate the target language that will be used to generate the query.
void	IDfCompletionFilter.onComplete(IDfContext context)

Uses of DfException in com.documentum.fc.common

Subclasses of DfException in com.documentum.fc.common

Modifier and Type	Class	Description
class	DfValidationException	DfValidationException will be thrown when a validation rule is violated

Methods in com.documentum.fc.common that return DfException

Modifier and Type	Method	Description
static DfException	DfException.appendException(DfException exptHead, DfException e, int stopAfterNumOfErrors)	Appends a DfException to the end of an exception chain.
static DfException	DfException.convert(Exception e)
static DfException	DfException.materializedLightObjectException(IDfId id)
static DfException	DfException.newAlreadyMaterializedException(IDfId objectId)
static DfException	DfException.newApiBadType(IDfId componentId, String typeName)
static DfException	DfException.newAspectMissingPropertyBag(String aspectName, IDfId objId, String typeName)
static DfException	DfException.newAuditTrailOutOfRangeException(int valueIndex, String attributeName, int count)
static DfException	DfException.newBadCacheTypeNameException(String cacheTypeName)
static DfException	DfException.newBadClassException(String className, String baseClassName, Throwable cause)
static DfException	DfException.newBadDataTypeException(int dataType)
static DfException	DfException.newBadDateException(String value, String pattern)
static DfException	DfException.newBadDocbaseScopeIdException(long docbaseId)
static DfException	DfException.newBadFlushArgException(String flushType)
static DfException	DfException.newBadIdException(IDfId id)
static DfException	DfException.newBadTypeException(String typeName)
static DfException	DfException.newCannotChangeSharedParentException()
static DfException	DfException.newCannotDestroyAspect(String aspectName)
static DfException	DfException.newCantApplyException(String methodName)
static DfException	DfException.newCantExportDirtyObjectException(IDfId id)
static DfException	DfException.newCantFetchInvalidId(String objectId)
static DfException	DfException.newCantWithOpenTranException(String operationName)
static DfException	DfException.newClassNotFoundException(String className, Throwable cause)
static DfException	DfException.newDecodingFailedException(String tokenName, String tokenValue, Throwable cause)
static DfException	DfException.newDeserializeFailedException(String serializedValue, Throwable cause)
static DfException	DfException.newDynamicGroupUpdateException()
static DfException	DfException.newFailedPolicyUpdateException(Throwable cause)
static DfException	DfException.newFlushDDCacheBadKeyException(String cacheKey)
static DfException	DfException.newFlushDDCacheNoKeyException()
static DfException	DfException.newFlushRegistryCacheNoKeyException()
static DfException	DfException.newIllegalDateFormatException(String value)
static DfException	DfException.newIllegalSBOAccessException(String sboName)
static DfException	DfException.newInvalidAspectName(String aspectName)
static DfException	DfException.newInvalidDefaultValue(String typeName, String attrName, String defaultValue)
static DfException	DfException.newInvalidNewObjectException(String typeName)
static DfException	DfException.newInvalidTypeException(String typeName, IDfId objectId, String requiredTypeName)
static DfException	DfException.newMaterializationOptionMismatchException(IDfId objectId)
static DfException	DfException.newMultipleObjectsQualify(String predicate, String docbaseName)
static DfException	DfException.newNoCacheKeyException()
static DfException	DfException.newNoCacheNameException()
static DfException	DfException.newNoCacheTypeNameException()
static DfException	DfException.newNoEventNameException(String commandName)
static DfException	DfException.newNoIdException(String api)
static DfException	DfException.newProxyInstantiateFailedException(String className, Throwable cause)
static DfException	DfException.newQueryFailException(String dql, Throwable cause)
static DfException	DfException.newQuerySessionClosedException()
static DfException	DfException.newReplicaAspectGenerationFailed(String className, Throwable cause)
static DfException	DfException.newRetentionOnParkedContentDisabled()
static DfException	DfException.newSerializeFailedException(Object object, Throwable cause)
static DfException	DfException.newShareableTypeMismatchException(String shareableTypeName)
static DfException	DfException.newTransactionActiveException()
static DfException	DfException.newTransactionLostException()
static DfException	DfException.newUnsupportedLoginTicketObjectVersionException(int version)
static DfException	DfException.newUpdateBadAttrException(String attributeName)
static DfException	DfException.newWrongCacheNameException(String cacheName)
static DfException	DfException.noLightweightParentTypeException(String lwTypeName)
static DfException	DfException.notShareableParentTypeException(String lwTypeName)

Methods in com.documentum.fc.common with parameters of type DfException

Modifier and Type	Method	Description
static DfException	DfException.appendException(DfException exptHead, DfException e, int stopAfterNumOfErrors)	Appends a DfException to the end of an exception chain.
final void	DfException.setNextException(DfException nextException)

Methods in com.documentum.fc.common that throw DfException

Modifier and Type	Method	Description
int	IDfList.append(Object value)	Appends an Object instance to the list.
int	IDfList.appendBoolean(boolean value)	Appends a boolean value to the list.
int	IDfList.appendDouble(double value)	Appends a double value to the list.
static DfException	DfException.appendException(DfException exptHead, DfException e, int stopAfterNumOfErrors)	Appends a DfException to the end of an exception chain.
int	IDfList.appendId(IDfId value)	Appends an instance of an IDfId object to the list.
int	IDfList.appendInt(int value)	Appends an int value to the list.
int	IDfList.appendList(IDfList value)	Appends an instance of an IDfList object to the list.
int	IDfList.appendString(String value)	Appends a string value to the list.
int	IDfList.appendTime(IDfTime value)	Appends an instance of an IDfTime object to the list.
int	IDfList.appendValue(IDfValue value)	Appends an instance of an IDfValue object to the list.
int	IDfValue.compareTo(IDfValue value)	Indicates whether the value stored in the calling value object is less than, equal to, or greater than the value stored in a user-supplied value object.
int	IDfList.findBooleanIndex(boolean value)	Returns the index of the first occurrence of a boolean value in the list.
int	IDfList.findDoubleIndex(double value)	Returns the index of the first occurrence of a double value in the list.
int	IDfList.findIdIndex(IDfId value)	Returns the index of the first occurrence of an IDfId object in the list.
int	IDfList.findIndex(Object value)	Returns the index of the first occurrence of the Object in the list.
int	IDfList.findIntIndex(int value)	Returns the index of the first occurrence of an int value in the list.
int	IDfList.findListIndex(IDfList value)	Returns the index of the first occurrence of an IDfList object in the list.
int	IDfList.findStringIndex(String value)	Returns the index of the first occurrence of a string value in the list.
int	IDfList.findTimeIndex(IDfTime value)	Returns the index of the first occurrence of an IDfTime object in the list.
int	IDfList.findValueIndex(IDfValue value)	Returns the index of the first occurrence of an IDfValue object in the list.
Object	IDfList.get(int index)	Fetches an Object instance from the list at the specified index.
boolean	IDfList.getBoolean(int index)	Fetches a boolean value from the list at the specified index.
boolean	IDfProperties.getBoolean(String propertyName)	Returns the boolean value to which the specified property name is mapped to in the object.
double	IDfList.getDouble(int index)	Fetches a double value from the list at the specified index.
double	IDfProperties.getDouble(String propertyName)	Returns the value to which the specified property name is mapped to in the object.
int	IDfList.getElementTypeAt(int index)	Returns the datatype of the items added to the list at the specified index.
IDfId	IDfList.getId(int index)	Fetches an instance of an IDfId object from the list at the specified index.
IDfId	IDfProperties.getId(String propertyName)	Returns an IDfId interface to which the specified property name is mapped to in the object.
int	IDfList.getInt(int index)	Fetches an int value from the list at the specified index.
int	IDfProperties.getInt(String propertyName)	Returns the value to which the specified property name is mapped to in the object.
double	IDfSearchable.getKeyAt(int index)	Returns the integer element at the specified index.
IDfList	IDfList.getList(int index)	Fetches an instance of an IDfList object from the list at the specified index.
IDfList	IDfProperties.getList(String propertyName)	Returns an IDfList interface to which the specified property name is mapped to in the object.
MBeanServer	IDfMBeanServerProvider.getMBeanServer()	Returns a handle to a specific MBeanServer, depending on the application server against which this has been implemented.
String	IDfMBeanServerProvider.getMBeanServerDomain()
IDfList	IDfProperties.getProperties()	Returns the property names as an IDfList interface.
int	IDfProperties.getPropertyType(String propertyName)	Return the datatype of the mapped property value.
String	IDfList.getString(int index)	Fetches a string value from the list at the specified index.
String	IDfProperties.getString(String propertyName)	Returns the string to which the specified property name is mapped to in the object.
IDfTime	IDfList.getTime(int index)	Fetches an instance of an IDfTime object from the list at the specified index.
IDfTime	IDfProperties.getTime(String propertyName)	Returns an IDfTime interface to which the specified property name is mapped to in the object.
IDfValue	IDfList.getValue(int index)	Fetches an instance of an IDfValue object from the list at the specified index.
IDfValue	IDfProperties.getValue(String propertyName)	Returns an IDfValue interface to which the specified property name is mapped to in the object.
void	IDfList.insert(int index, Object value)	Inserts an Object instance into the list at a specified index.
void	IDfList.insertAll(int index, IDfList list)	Inserts all objects contained in an IDfList object into the list at a specified index.
void	IDfList.insertBoolean(int index, boolean value)	Inserts a boolean value into the list at a specified index.
void	IDfList.insertDouble(int index, double value)	Inserts a double value into the list at a specified index.
void	IDfList.insertId(int index, IDfId value)	Inserts an instance of an IDfId object into the list at a specified index.
void	IDfList.insertInt(int index, int value)	Inserts an int value into the list at a specified index.
void	IDfList.insertList(int index, IDfList value)	Inserts an instance of an IDfList object into the list at a specified index.
void	IDfList.insertString(int index, String value)	Inserts a string value into the list at a specified index.
void	IDfList.insertTime(int index, IDfTime value)	Inserts an instance of an IDfTime object into the list at a specified index.
void	IDfList.insertValue(int index, IDfValue value)	Inserts an instance of an IDfValue object into the list at a specified index.
List<com.documentum.fc.common.LabelInfo>	IMipLabelService.listMipLabels()	listMipLabels methos is resposible for retruning the label from server
boolean	IMipLabelService.refreshMipCache()	Refreshes the Microsoft Information Protection (MIP) cache.
void	IDfList.remove(int index)	Removes an item from the list at the specified index.
void	IDfList.set(int index, Object value)	Adds an Object instance into the list at a specified index.
void	IDfList.setBoolean(int index, boolean value)	Adds a boolean value into the list at a specified index.
void	IDfList.setDouble(int index, double value)	Adds a double value into the list at a specified index.
void	IDfList.setId(int index, IDfId value)	Adds an instance of an IDfId interface into the list at a specified index.
void	IDfList.setInt(int index, int value)	Adds an int value into the list at a specified index.
void	IDfList.setList(int index, IDfList value)	Adds an instance of an IDfList interface into the list at a specified index.
void	IDfList.setString(int index, String value)	Adds a string value into the list at a specified index.
void	IDfList.setTime(int index, IDfTime value)	Adds an instance of an IDfTime interface into the list at a specified index.
void	IDfList.setValue(int index, IDfValue value)	Adds an instance of an IDfValue interface into the list at a specified index.

Uses of DfException in com.documentum.fc.lifecycle

Methods in com.documentum.fc.lifecycle that throw DfException

Modifier and Type	Method	Description
void	IDfLifecycleAction.action(IDfSysObject sysObj, String userName, String targetState, Map parameters)	System-defined action on an object entering a new Lifecycle state.
void	IDfLifecycleUserAction.userAction(IDfSysObject sysObj, String userName, String targetState)	User defined actions on an object entering a new Lifecycle state.
boolean	IDfLifecycleUserEntryCriteria.userEntryCriteria(IDfSysObject sysObj, String userName, String targetState)	User defined entry criteria to determine if an object can enter a new Lifecycle state.
void	IDfLifecycleUserPostProcessing.userPostProcessing(IDfSysObject sysObj, String userName, String targetState)	User defined actions on an object after it has moved to a new Lifecycle state.
boolean	IDfLifecycleValidate.userValidate(IDfSysObject lifecycleObj, String userName)	User defined validation to determine if Lifecycle can be installed.

Uses of DfException in com.documentum.operations

Methods in com.documentum.operations that throw DfException

Modifier and Type	Method	Description
void	IDfOperation.abort()	Abort the operation.
IDfOperationNode	IDfOperation.add(Object newObject)	Adds an object to the operation and returns an operation node for the newly added object.
IDfOperationNode	IDfOperationNodeTreeBuilder.add(IDfOperationNode parentNode, IDfNodeRelationship nodeRelationship, Object obj)	Results in appending a node for the corresponding object as a child node of the given parentNode by iterating through list of populators for the operation.
IDfOperationNode	IDfOperationNodeTreeBuilder.add(Object obj)	This method results in adding a node for the corresponding object as root node.
boolean	IDfOperation.canUndo()	Indicates whether the operation can be undone.
void	IDfVDMPlatformUtils.copyFile(String sourceFile, String destFile)
boolean	IDfOperation.execute()	Execute the operation.
boolean	IDfOperationStep.execute()	Executes the action(s) of the step, for example a "check in" step would cause the objects in the operation to each be checked in to the docbase.
void	IDfStepAction.execute()	The business logic of the step action.
IDfEnumeration	IDfCheckoutNode.getAcsRequests()	Returns an IDfEnumeration object with a list of IDfAcsRequest objects.
IDfEnumeration	IDfExportNode.getAcsRequests()	Returns an IDfEnumeration object containing a list of IDfAcsRequest objects.
String	IDfXMLUtils.getApplication(String applicationName, boolean returnSingleApp)	Deprecated. DFC 5.2
String	IDfXMLUtils.getApplicationByDTD(String dtdSystemId, String dtdPublicId, String namespace, String rootElement, boolean returnSingleApp)	Deprecated. DFC 5.2.
IDfList	IDfXMLUtils.getApplicationList(IDfXMLDocType doctype)	Returns a list strings containing object IDs and object names.
IDfList	IDfXMLUtils.getApplicationList(IDfXMLDocType doctype, IDfFormat formatObj)	Returns a list strings containing object IDs and object names.
IDfList	IDfXMLUtils.getApplicationList(IDfXMLDocType doctype, IDfSysObject object)	Returns a list strings containing object IDs and object names.
IDfList	IDfXMLUtils.getApplicationList(IDfXMLDocType doctype, IDfFile file)	Returns a list strings containing object IDs and object names.
IDfList	IDfXMLUtils.getApplicationList(IDfXMLDocType doctype, String fileOrFormatName)	Returns a list strings containing object IDs and object names.
IDfList	IDfXMLUtils.getApplicationList(String applicationName)	Return a list of object IDs.
IDfList	IDfXMLUtils.getApplicationListByDTD(String dtdSystemId, String dtdPublicId, String namespace, String rootElement, boolean returnSingleApp)	Deprecated. DFC 5.2
int	IDfCheckinNode.getCheckinVersion()	Returns an integer indicating how versioning should be handled on check in.
int	IDfCheckinOperation.getCheckinVersion()	Returns an integer indicating how versioning should be handled on check in.
IDfList	IDfOperationNode.getChildren()	Returns a list of the immediate children of this node.
String	IDfVDMPlatformUtils.getCLSIDForFile(String filePath)
int	IDfCheckinNode.getContentPageNumber()	Returns the content page number for the local content file for this object.
int	IDfExportNode.getContentPageNumber()	Returns the content page number for the local content fille for this object.
int	IDfPredictiveCachingNode.getContentPageNumber()	Returns the content page number for the local content file for this object.
int	IDfCopyOperation.getCopyOptionsFlag()	Returns the current copy option settings.
int	IDfCopyOperation.getCopyPreference()	Returns an integer representing the copy option settings for the operation.
boolean	IDfCopyOperation.getDeepFolders()	When working with folders, copy the folder and all of its descendants.
String	IDfCheckoutOperation.getDefaultDestinationDirectory()	Returns the default file system directory path that is the output location for the outbound content files.
String	IDfExportOperation.getDefaultDestinationDirectory()	Returns the default file system directory path that is the output location for the outbound content files.
String	IDfCheckinNode.getDefaultFormat()	Returns the default repository format name for the local content file of this object.
String	IDfCheckoutNode.getDefaultFormat()	Returns the default content file format for this object in the repository.
String	IDfExportNode.getDefaultFormat()	Returns the default content file format for this object in the repository.
String	IDfImportNode.getDefaultFormat()	Returns the default repository format name for the local content file of this object.
String	IDfPredictiveCachingNode.getDefaultFormat()	Returns the default content file format for this object in the repository.
String	IDfFormatRecognizer.getDefaultSuggestedFileFormat()	Returns the repository format name that should be considered the default choice for the file being recognized.
String	IDfOperation.getDescription()	Returns the description of the operation.
String	IDfOperationStep.getDescription()	Returns the localized description of this step.
String	IDfCheckoutOperation.getDestinationDirectory()	Returns the file system directory path that is the default output location for the outbound content files.
String	IDfExportOperation.getDestinationDirectory()	Returns the file system directory path that is the default output location for the outbound content files.
String	IDfValidationOperation.getDestinationDirectory()	Gets the destination directory where the temporary file will be placed during validation of xml file.
IDfId	IDfCopyNode.getDestinationFolderId()	Returns the repository object ID of the destination folder for this node.
IDfId	IDfCopyOperation.getDestinationFolderId()	Returns the repository object ID of the destination folder for the copy operation.
IDfId	IDfImportNode.getDestinationFolderId()	Returns the repository object ID of the destination folder for the copy operation.
IDfId	IDfImportOperation.getDestinationFolderId()	Returns the docbase object Id of the destination folder for the copy operation.
IDfId	IDfMoveNode.getDestinationFolderId()	This is the folder where objects are being moved (linked).
IDfId	IDfMoveOperation.getDestinationFolderId()	Returns the docbase object Id of the destination folder for the move operation.
String	IDfImportNode.getDocbaseObjectType()	Returns the repository object type that is used to create the new repository object for the import node.
IDfProperties	IDfOperationNode.getEdgeProperties()	Retuns the propertes of the edge between this node and its immediate parent.
IDfList	IDfOperation.getErrors()	Returns the list of operation errors.
String	IDfCheckinNode.getExternalVariable(String varName)	Returns the value of an external variable.
String	IDfImportNode.getExternalVariable(String varName)	Returns the value of an external variable.
String	IDfCheckinNode.getFilePath()	Returns the content file path in the local file system for this node.
String	IDfCheckoutNode.getFilePath()	Returns the content file path in the local file system for this node.
String	IDfExportNode.getFilePath()	Returns the content file path in the local file system for this node.
String	IDfImportNode.getFilePath()	Returns the canonical path to the content file on the local file system for this node.
String	IDfCheckinNode.getFormat()	Returns the repository format name for the local content file of this object.
String	IDfCheckoutNode.getFormat()	Returns the repository format name for the local content file of this object.
String	IDfExportNode.getFormat()	Returns the repository format name for the local content file of this object.
String	IDfImportNode.getFormat()	Returns the repository format name for the local content file of this object.
String	IDfPredictiveCachingNode.getFormat()	Returns the repository format name for the local content file of this object.
IDfId	IDfOperationNode.getId()	Returns a unique identifier for this node.
boolean	IDfCancelCheckoutNode.getKeepLocalFile()	Returns a boolean value indicating whether or not the local content file should be preserved or deleted as part of the cancel checkout operation.
boolean	IDfCancelCheckoutOperation.getKeepLocalFile()	Returns a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
boolean	IDfCheckinNode.getKeepLocalFile()	Returns a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
boolean	IDfCheckinOperation.getKeepLocalFile()	Returns a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
boolean	IDfImportNode.getKeepLocalFile()	Returns a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
boolean	IDfImportOperation.getKeepLocalFile()	Returns a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
IDfEnumeration	IDfPredictiveCachingNode.getMessageIds()	Returns message IDs for all messages that have been created during the operation.execute() method for this node
String	IDfOperation.getName()	Returns the name of the operation (e.g.
String	IDfOperationStep.getName()	Returns the name of the operation step.
IDfList	IDfPredictiveCachingOperation.getNetworkLocationIds()	Returns a list of the network location identifiers to be used for content pre-caching.
IDfSysObject	IDfCheckinNode.getNewObject()	Returns the new IDfSysObject resulting from the check in.
IDfSysObject	IDfCopyNode.getNewObject()	Returns the new IDfSysObject resulting from the copy.
IDfSysObject	IDfImportNode.getNewObject()	Returns the new IDfSysObject resulting from the check in.
IDfId	IDfCheckinNode.getNewObjectId()	Returns the new repository object ID for the IDfSysObject resulting from the check in.
IDfId	IDfCopyNode.getNewObjectId()	Returns the new repository object ID for the IDfSysObject resulting from the copy.
IDfId	IDfImportNode.getNewObjectId()	Returns the new repository object ID for the IDfSysObject resulting from the check in.
String	IDfCopyNode.getNewObjectName()	Returns the object name used for the newly copied object.
String	IDfImportNode.getNewObjectName()	Returns the object name to be used for the newly imported object.
IDfList	IDfCheckinOperation.getNewObjects()	Returns the list of unique new objects created as a result of this operation.
IDfList	IDfCopyOperation.getNewObjects()	Returns the list of unique new objects created as a result of this operation.
IDfList	IDfImportOperation.getNewObjects()	Returns the list of unique new objects created as a result of this operation.
IDfList	IDfOperation.getNodes()	Returns the list of all operation nodes.
IDfSysObject	IDfCancelCheckoutNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfCheckinNode.getObject()	Returns the original IDfSysObject before check in.
IDfSysObject	IDfCheckoutNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfCopyNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfDeleteNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfExportNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfImportNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfMoveNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfSysObject	IDfPredictiveCachingNode.getObject()	Returns the IDfSysObject that is the subject of this operation node.
IDfId	IDfCancelCheckoutNode.getObjectId()	Returns the docbase object Id of the IDfSysObject for this node.
IDfId	IDfCheckinNode.getObjectId()	Returns the original repository object ID for the IDfSysObject before check in.
IDfId	IDfCheckoutNode.getObjectId()	Returns the repository object Id of the IDfSysObject for this node.
IDfId	IDfCopyNode.getObjectId()	Returns the repository object ID of the IDfSysObject for this node.
IDfId	IDfDeleteNode.getObjectId()	Returns the repository object ID of the IDfSysObject for this node.
IDfId	IDfExportNode.getObjectId()	Returns the repository object Id of the IDfSysObject for this node.
IDfId	IDfImportNode.getObjectId()	Returns the repository object ID of the IDfSysObject for this node.
IDfId	IDfMoveNode.getObjectId()	Returns the docbase object Id of the IDfSysObject for this node.
IDfId	IDfPredictiveCachingNode.getObjectId()	Returns the repository object ID of the IDfSysObject for this node.
IDfId	IDfXMLUtils.getObjectIdFromDRL(String drl)	Returns the object id corresponding to the DRL.
IDfList	IDfCancelCheckoutOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfCheckinOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfCheckoutOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfCopyOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfDeleteOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfExportOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfMoveOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfPredictiveCachingOperation.getObjects()	Returns the list of unique objects in this operation.
IDfList	IDfXMLUtils.getObjectTypes(String xmlApplication)	getObjectTypes - RESERVED FOR FUTURE USE.
String	IDfOperation.getOperationType()	Returns the type of the operation.
String	IDfExportNode.getPageModifier()	Returns the content page modifier for the local content file for this object.
String	IDfPredictiveCachingNode.getPageModifier()	Returns the content page modifier for the local content file for this object.
IDfOperationNode	IDfOperationNode.getParent()	Returns the node that is the immediate parent of this node.
IDfProperties	IDfOperation.getProperties()	Returns the properties of the operation.
IDfProperties	IDfOperationNode.getProperties()	Returns the properties of this node.
int	IDfExportNode.getRecordInRegistry()	Returns an integer that indicates if this node should be recorded in the client registry.
int	IDfExportOperation.getRecordInRegistry()	Returns an integer that indicates if this node should be recorded in the client registry.
boolean	IDfCheckinNode.getRetainLock()	Returns true if the repository object for this node should keep the lock after check in.
boolean	IDfCheckinOperation.getRetainLock()	Returns true if the docbase object for this node should keep the lock after check in.
IDfList	IDfOperation.getRootNodes()	Returns a list of the root level nodes of the operation.
IDfSession	IDfImportOperation.getSession()	Returns session to be used to import new objects.
IDfSession	IDfOperation.getSession()	Returns session to be used during operation execution
IDfId	IDfMoveNode.getSourceFolderId()	This is the folder from which objects are being moved (unlinked).
IDfId	IDfMoveOperation.getSourceFolderId()	Gets the source folder id for the move operation.
IDfList	IDfOperation.getSteps()	Returns the list of operation steps.
IDfList	IDfFormatRecognizer.getSuggestedFileFormats()	Returns a list of format choices for a given file path.
String	IDfFile.getURI()	Return the absolute path for the file as a URI.
int	IDfDeleteOperation.getVersionDeletionPolicy()	Returns the delete operation population type.
String	IDfCheckinNode.getVersionLabels()	Returns the symbolic version labels that will be applied when the node is checked in.
String	IDfCheckinOperation.getVersionLabels()	Returns the symbolic version labels that will be applied when the node is checked in.
String	IDfImportNode.getVersionLabels()	Returns the symbolic version labels that are applied when the node is checked in.
String	IDfImportOperation.getVersionLabels()	Returns the symbolic version labels that will be applied when the node is checked in.
IDfXMLDocType	IDfXMLUtils.getXMLDoctypeFromFile(String filename)	Returns an IDfXMLDocType which encapsulates information from the given XML document: public ID, system ID, schemaLocation, root element and XML application (if a processing instruction was found that indicates the XML application.
int	IDfOperationMonitor.getYesNoAnswer(IDfOperationError question)	Called by operation when an error / warning requires a yes or no response.
IDfList	IDfXMLUtils.getZones(String xmlApplication)	getZones - RESERVED FOR FUTURE USE.
boolean	IDfCheckinNode.isEnabledOLELinksProcessing()	Returns true if OLE links processing is enabled
boolean	IDfImportNode.isEnabledOLELinksProcessing()	Returns true if OLE links processing is enabled
boolean	IDfXMLUtils.isHTML(Object fileOrFormatObj)	isHTML - RESERVED FOR FUTURE USE.
boolean	IDfOperationNode.isRoot()	Returns true if this node is a root level node (has no parent).
boolean	IDfXMLUtils.isXML(Object fileOrFormatObject)	Returns a boolean value to indicate whether the given file or format is XML, in terms of XML processing (i.e.
void	IDfOperation.logError(IDfOperationError error)	Records an operation error.
IDfOperationNode	IDfOperationNodeFactory.newNode(IDfId id)	Creates a new node for the given object.
IDfOperationNode	IDfOperationNodeFactory.newNode(IDfFile file)	Creates a new node for the given file.
IDfOperationNode	IDfOperationNodeFactory.newNode(IDfInputStreamContent inputStreamContent)	Creates a new node for the given inputStream.
IDfNodeRelationship	IDfOperationNodeFactory.newNodeRelationship(IDfId parentId, IDfId childId, String relationType)
IDfOperationNode	IDfNodePopulator.process(Object newObject)	Builds an IDfOperationNode
int	IDfOperationMonitor.progressReport(IDfOperation operation, int operationPercentDone, IDfOperationStep step, int stepPercentDone, IDfOperationNode node)
void	IDfOperation.removeNode(IDfOperationNode nodeToRemove)	Removes an operation node (and its descendants) from the operation.
void	IDfOperation.reportError(IDfOperationNode node, int errorCode, String message, IDfException dfException)	Report an error.
int	IDfOperationMonitor.reportError(IDfOperationError error)	This method is called when an operation informs the monitor of the occurance of an error.
void	IDfOperation.resetErrors()	Clears any logged errors for this operation.
void	IDfOperationContext.set(String key, String value)	Allows setting contextual information in the form of key, value pair.
void	IDfCheckinNode.setCheckinVersion(int checkinVersion)	Takes an integer indicating how versioning should be handled on check in.
void	IDfCheckinOperation.setCheckinVersion(int checkinVersion)	Returns an integer indicating how versioning should be handled on check in.
void	IDfCheckinNode.setContentPageNumber(int pageNumber)	Sets the content page number for the local content file of this object.
void	IDfExportNode.setContentPageNumber(int pageNumber)	Sets the content page number for the local content fille of this object.
void	IDfPredictiveCachingNode.setContentPageNumber(int pageNumber)	Sets the content page number for the local content file of this object.
void	IDfCopyOperation.setDeepFolders(boolean deepFolders)	When working with folders, copy the folder and all of its descendants.
void	IDfXMLTransformNode.setDestination(Object destinationObject)	Specify the transformed document's destination.
void	IDfXMLTransformOperation.setDestination(Object destinationObject)	Specify the transformed document's destination.
void	IDfCheckoutOperation.setDestinationDirectory(String dirPath)	Sets the file system directory path that is the default output location for the outbound content files.
void	IDfExportOperation.setDestinationDirectory(String dirPath)	Sets the file system directory path that is the default output location for the outbound content files.
void	IDfValidationOperation.setDestinationDirectory(String dirPath)	Sets the destination directory where the temporary file will be placed during validation of xml file.
void	IDfCopyNode.setDestinationFolderId(IDfId destinationFolderId)	Sets the repository object ID of the destination folder for this node.
void	IDfCopyOperation.setDestinationFolderId(IDfId folderId)	Sets the repository object ID for the destination folder for the copy operation.
void	IDfImportNode.setDestinationFolderId(IDfId destinationFolderId)	Sets the repository object ID for the destination folder for the copy operation.
void	IDfImportOperation.setDestinationFolderId(IDfId destinationFolderId)	Sets the docbase object Id for the destination folder for the copy operation.
void	IDfMoveNode.setDestinationFolderId(IDfId destFolderId)	Sets the docbase object Id of the destination folder for this node.
void	IDfMoveOperation.setDestinationFolderId(IDfId folderId)	Sets the docbase object Id for the destination folder for the move operation.
void	IDfImportNode.setDocbaseObjectType(String docbaseType)	Sets the repository object type that is used to create the new repository object for the import node.
void	IDfCheckoutNode.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	IDfCheckinNode.setExternalVariable(String varName, String value)	Sets a variable that will be available to the XML application's configuration file as an <external_variable>.
void	IDfImportNode.setExternalVariable(String varName, String value)	Sets a variable that is available to the XML application's configuration file as an <external_variable>.
void	IDfCheckinNode.setFilePath(String newFilePath)	Sets the file path to use as the content for this object.
void	IDfCheckoutNode.setFilePath(String newFilePath)	Sets the local path to the file that contains the content of this node.
void	IDfExportNode.setFilePath(String newFilePath)	Sets the file path to use as the contents of this object.
void	IDfImportNode.setFilePath(String newFilePath)	Sets the file path to use as the contents of this object.
void	IDfCheckinNode.setFormat(String formatName)	Sets the repository format name of the local content file for this object.
void	IDfCheckoutNode.setFormat(String formatName)	Sets the repository format name of the local content file for this object.
void	IDfExportNode.setFormat(String formatName)	Sets the repository format name of the local content file for this object.
void	IDfImportNode.setFormat(String formatName)	Sets the repository format name of the local content file for this object.
void	IDfPredictiveCachingNode.setFormat(String formatName)	Sets the repository format name of the local content file for this object.
void	IDfXMLTransformNode.setInputFormat(String inputFormat)	Specify the input format for input object.
void	IDfCancelCheckoutNode.setKeepLocalFile(boolean keepFile)	Sets a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
void	IDfCancelCheckoutOperation.setKeepLocalFile(boolean keepFile)	Sets a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
void	IDfCheckinNode.setKeepLocalFile(boolean keepFile)	Sets a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
void	IDfCheckinOperation.setKeepLocalFile(boolean keepFile)	Sets a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
void	IDfImportNode.setKeepLocalFile(boolean keepFile)	Sets a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
void	IDfImportOperation.setKeepLocalFile(boolean keepFile)	Sets a boolean value indicating whether or not the local content file should be preserved or deleted as part of the operation.
void	IDfExportNode.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	IDfXMLTransformNode.setName(String name)	Sets the name for this input transform node.
void	IDfPredictiveCachingOperation.setNetworkLocationIds(IDfList networkLocationIds)	Sets the list of the network location identifiers to be used for content pre-caching.
void	IDfCopyNode.setNewObjectName(String newObjectName)	Sets the name for the new copy of the object.
void	IDfImportNode.setNewObjectName(String newObjectName)	Sets the name to be used for the new copy of the object.
IDfOperationMonitor	IDfOperation.setOperationMonitor(IDfOperationMonitor monitor)	Sets the interface to be used to monitor events in the operation.
void	IDfXMLTransformNode.setOutputFormat(String outputFormat)	Specify the destination format for the output of the transformation.
void	IDfExportNode.setPageModifier(String pageModifier)	Sets the content page modifier for the local content file for this object.
void	IDfPredictiveCachingNode.setPageModifier(String pageModifier)	Sets the content page modifier for the local content file for this object.
void	IDfExportNode.setRecordInRegistry(int registryRecordingPreference)	Sets an integer that indicates if this node should be recorded in the client registry.
void	IDfExportOperation.setRecordInRegistry(int registryRecordingPreference)	Sets an integer that indicates if this node should be recorded in the client registry.
void	IDfCheckinNode.setRetainLock(boolean retainLock)	Sets whether or not the repository object for this node should keep the lock after check in.
void	IDfCheckinOperation.setRetainLock(boolean retainLock)	Sets whether or not the docbase object for this node should keep the lock after check in.
void	IDfImportOperation.setSession(IDfSession importSession)	Sets the session that will be used to create new docbase objects.
void	IDfOperation.setSession(IDfSession session)	Sets the session that will be used during operation execution.
void	IDfXMLTransformNode.setSession(IDfSession session)	Set the session that will be used by this operation.
void	IDfXMLTransformOperation.setSession(IDfSession session)	Set the session that will be used by this operation.
void	IDfMoveNode.setSourceFolderId(IDfId sourceFolderId)	Sets the docbase object Id of the source folder for this node.
void	IDfMoveOperation.setSourceFolderId(IDfId sourceFolderId)	Sets the source folder id for the move operation.
void	IDfXMLTransformNode.setTransformation(Object transformObject)	Specify the XSLT transformation object that will be applied to this input node.
void	IDfXMLTransformOperation.setTransformation(Object transformObject)	Specify the XSLT transformation object that will be applied to the input.
void	IDfDeleteOperation.setVersionDeletionPolicy(int whichVersions)	Sets the delete operation population type.
void	IDfCheckinNode.setVersionLabels(String newVersionLabels)	Sets the symbolic version labels that will be applied when the node is checked in.
void	IDfCheckinOperation.setVersionLabels(String newVersionLabels)	Sets the symbolic version labels that will be applied when the node is checked in.
void	IDfImportNode.setVersionLabels(String newVersionLabels)	Sets the symbolic version labels that are applied when the node is checked in.
void	IDfImportOperation.setVersionLabels(String newVersionLabels)	Sets the symbolic version labels that will be applied when the node is checked in.
void	IDfXMLTransformOperation.setXSLTParameter(String paramName, String value)	Specify a parameter that will be passed to the stylesheet.
boolean	IDfOperation.succeeded(Object object)	Check if the operation succeded for the specified object.
boolean	IDfDeleteNode.wasDeleted()	Returns true if the object for this node was actually deleted as the result of this operation.

Uses of DfException in com.documentum.registry

Methods in com.documentum.registry that throw DfException

Modifier and Type	Method	Description
IDfCheckedOutObject	IDfClientRegistry.addCheckedOutObject(IDfSysObject sysObject, String filePath, boolean keepLocalFile, String folderPath)	Constructs a DfCheckedOutObject and writes it to the registry
void	IDfViewedObject.addFilePath(String filePath)	Adds the file path to the existing viewed object.
void	IDfClientRegistry.addFileToBeDeleted(String filePath)	Adds a file to the "to be deleted" list in the registry
IDfLocalObject	IDfClientRegistry.addLocalObject(IDfSysObject sysObject, String filePath, boolean keepLocalFile, String folderPath)	Constructs a DfLocalObject and writes it to the registry
void	IDfCheckedOutObject.addSharedDocument(IDfId parentId)	Adds the object id of the parent that shares this checked out object.
IDfViewedObject	IDfClientRegistry.addViewedObject(IDfSysObject sysObject, String filePath, String folderPath)	Constructs a DfViewedObject and writes it to the registry
void	IDfClientRegistry.applyModifiedAttrs(IDfSysObject sysObject)	updates a checked-out object's attributes with those from a sysobject
void	IDfRegistry.closeKey()
void	IDfRegistry.createKey()
void	IDfRegistry.deleteSubKey(String subKey)
void	IDfRegistry.deleteSubKeys()
void	IDfRegistry.deleteValue(String name)
void	IDfRegistry.flush()
IDfList	IDfRegistry.getBinaryValue(String name)
IDfList	IDfRegistry.getBinaryValueAt(String name, int index)
IDfList	IDfRegistry.getBinaryValues(String name)
IDfCheckedOutObject	IDfClientRegistry.getCheckedOutObjectById(IDfId objectId)	Finds a checked-out file registry object based on object ID
IDfCheckedOutObject	IDfClientRegistry.getCheckedOutObjectByPath(String filePath)	Finds a checked-out file registry object based on file path
IDfList	IDfClientRegistry.getCheckedOutObjects()	Gets all the checked out objects
String	IDfClientRegistry.getCheckoutDirectory()
String	IDfClientRegistry.getExportDirectory()
IDfList	IDfViewedObject.getFilePaths()	It is possible that the given viewed object may have more than one file path.
IDfList	IDfClientRegistry.getFilesToBeDeleted()	Gets the list of files to be deleted
int	IDfRegistry.getIntValue(String name)
int	IDfRegistry.getIntValueAt(String name, int index)
IDfList	IDfRegistry.getIntValues(String name)
IDfLocalObject	IDfClientRegistry.getLocalObjectById(IDfId objectId)	Finds a local file registry object based on object ID
IDfLocalObject	IDfClientRegistry.getLocalObjectByPath(String filePath)	Finds a local file registry object based on object ID
IDfList	IDfClientRegistry.getLocalObjects()	Gets all the checked out objects
String	IDfCheckedOutObject.getMasterObjectId()	Returns the master object id of the current checked out object.
String	IDfCheckedOutObject.getModifiedAttr(String name)	Gets the value of a modified attribute.
IDfList	IDfCheckedOutObject.getModifiedAttrs()	Returns a list of attribute names for the attributes that have been modified while the document is checked out.
String	IDfClientRegistry.getProgramDirectory()
IDfList	IDfCheckedOutObject.getSharedDocuments()	Returns the list of the object id's of all the documents that share this checked out object
String	IDfRegistry.getStringValue(String name)
String	IDfRegistry.getStringValueAt(String name, int index)
IDfList	IDfRegistry.getStringValues(String name)
String	IDfClientRegistry.getUserDirectory()
int	IDfRegistry.getValuesSize(String name)
IDfViewedObject	IDfClientRegistry.getViewedObjectById(IDfId objectId)	Finds a viewed file registry object based on object ID
IDfViewedObject	IDfClientRegistry.getViewedObjectByPath(String filePath)	Finds a viewed file registry object based on file path
IDfList	IDfClientRegistry.getViewedObjects()	Gets all the viewed objects
boolean	IDfRegistry.isSubKey(String subKey)
boolean	IDfRegistry.isValueNamePresent(String name)
void	IDfClientRegistryObject.loadFromRegistry(String objId)	Reads the information from the registry into the object
void	IDfClientRegistry.moveToCheckedOutFiles(IDfLocalObject object)	Removes a local file and places it in the list of checked-out files.
void	IDfClientRegistry.moveToLocalFiles(IDfCheckedOutObject object, IDfSession session)	Removes a checked out file and places it in the list of local files.
void	IDfRegistry.openKey(String subKey)
void	IDfClientRegistry.removeCheckedOutObject(IDfCheckedOutObject itemToRemove)	Removes a checked-out file object from the registry
void	IDfViewedObject.removeFilePath(String filePath)	Removes the file path from the existing viewed object.
void	IDfClientRegistry.removeFileToBeDeleted(String filePath)	Removes a file from the list of files to be deleted
void	IDfClientRegistry.removeLocalObject(IDfLocalObject itemToRemove)	Removes a local object from the registry
void	IDfCheckedOutObject.removeSharedDocument(IDfId parentId)	Removes the object id of the document that shares this checked out object.
void	IDfClientRegistry.removeViewedObject(IDfViewedObject itemToRemove)	Removes a viewed object from the registry
void	IDfRegistry.reset()
void	IDfRegistry.setBinaryValue(String name, IDfList data)
void	IDfRegistry.setBinaryValueAt(String name, int index, IDfList data)
void	IDfRegistry.setBinaryValues(String name, IDfList data)
void	IDfClientRegistry.setCheckoutDirectory(String checkoutDir)	Sets in the registry the directory where checked out files will be placed
void	IDfClientRegistry.setExportDirectory(String exportDir)	Sets in the registry the directory exported files will be written to
void	IDfRegistry.setIntValue(String name, int data)
void	IDfRegistry.setIntValueAt(String name, int index, int data)
void	IDfRegistry.setIntValues(String name, IDfList data)
void	IDfCheckedOutObject.setMasterObjectId(String masterObjectId)	Sets the master object id of the replica or reference object.
void	IDfCheckedOutObject.setModifiedAttr(String name, String value)	Marks that an attribute has been changed with the checked-out object.
void	IDfClientRegistry.setProgramDirectory(String progDir)
void	IDfRegistry.setStringValue(String name, String data)
void	IDfRegistry.setStringValueAt(String name, int index, String data)
void	IDfRegistry.setStringValues(String name, IDfList data)
void	IDfClientRegistry.setUserDirectory(String userDir)	Sets in the registry the user's directory
void	IDfRegistry.setValuesSize(String name, int size)
IDfList	IDfRegistry.subKeys()
void	IDfClientRegistryObject.updateRegistry()	Writes the information in the object to the registry
IDfList	IDfRegistry.values()

Uses of DfException in com.documentum.xml.xdql

Methods in com.documentum.xml.xdql that throw DfException

Modifier and Type	Method	Description
Document	IDfXmlQuery.getXMLDOM(Node start)	Returns the XML document as a DOM with the specified node as root element.
String	IDfXmlQuery.getXMLString()	This returns the XML document as a string.
void	IDfXmlQuery.getXMLString(OutputStream outputStream)	Returns the result DOM as String and writes it directly into the provided OutputStream.
void	IDfXmlQuery.getXMLString(PrintWriter writer)	Returns the result DOM as String and writes it directly into the provided writer.
String	IDfXmlQuery.getXMLString(Node start)	Returns the XML document as a string with Node as root element.

Uses of DfException in com.documentum.xml.xquery

Methods in com.documentum.xml.xquery that throw DfException

Modifier and Type	Method	Description
void	IDfXQuery.close(IDfSession session)	Closes the XQuery results stream.
void	IDfXQuery.execute(IDfSession session)	Executes the XQuery.
void	IDfXQuery.execute(IDfSession session, com.documentum.xml.xquery.IDfXQueryTargets target)	Executes the XQuery on targets passed in as the parameter.
String	IDfXQuery.getCutoffMessage()	Retrieve the cutoff messages from ESS after the query is executed.
String	IDfXQuery.getDebugInfo(IDfSession session, IDfXQuery.FtQueryDebugOptions debugOption)	Retrieve debugging information associated with this query
String	IDfXQuery.getExecutionPlan(IDfSession session)	Retrieve the xquery execution plan from ESS after the query is executed.
String	IDfXQuery.getOption(IDfXQuery.FtQueryOptions option)	To get the value of the option that was set.
void	IDfXQuery.getXMLFile(String filename)	Writes the XQuery results to a file.
void	IDfXQuery.getXMLOutputStream(OutputStream outputStream)	Writes the XQuery results to an OutputStream object.
String	IDfXQuery.getXMLString()	Returns the XQuery results as a Java String object.
int	IDfXQuery.readResults(byte[] buffer)	Fills the given buffer with the next set of XQuery results.
int	IDfXQuery.readResults(byte[] buffer, IDfSession session)	Fills the given buffer with the next set of XQuery results.
void	IDfXQuery.setBooleanOption(IDfXQuery.FtQueryOptions option, boolean value)	Set an FtQueryOption to apply to the xquery.
void	IDfXQuery.setIntegerOption(IDfXQuery.FtQueryOptions option, int value)	Set an FtQueryOption to apply to the xquery.
void	IDfXQuery.setMapOption(IDfXQuery.FtQueryOptions option, Map<String,String> value)	Set an FtQueryOption to apply to the xquery.
void	IDfXQuery.setStringOption(IDfXQuery.FtQueryOptions option, String value)	Set an FtQueryOption to apply to the xquery.