# Uses of Interface
com.documentum.fc.client.IDfSysObject

Packages that use IDfSysObject
Package
Description
com.documentum.com
Provides an interface for accessing the DFC through OLE/COM.
com.documentum.fc.client
com.documentum.fc.client.acs
Provides classes and interfaces, related to distributed content transfer.
com.documentum.fc.client.dcis.embd
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.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.

- ## Uses of IDfSysObject in com.documentum.com

  Methods in com.documentum.com with parameters of type IDfSysObject
  Modifier and Type
  Method
  Description
  `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.

- ## Uses of IDfSysObject in com.documentum.fc.client

  Subinterfaces of IDfSysObject in com.documentum.fc.client
  Modifier and Type
  Interface
  Description
  `interface`
  `IDfActivity`
  This interface provides functions to access objects of dm_activity type.
  `interface`
  `IDfDocument`
  Provides the functionality for the client to interact with "dm_document" objects in the respository.
  `interface`
  `IDfFolder`
  This interface provides access to folder-related data stored in folder objects.
  `interface`
  `IDfLocation`
  This interface provides access to location properties.
  `interface`
  `IDfMethodObject`
  `interface`
  `IDfMountPoint`
  This interface provides access to mount point-related data stored in dm_mount_point objects.
  `interface`
  `IDfNote`
  This class provides the functionality for the client to interact with "dm_sysobject" objects in the repository.
  `interface`
  `IDfPlugin`
  This interface provides access to plugin-related data stored in dm_plugin objects.
  `interface`
  `IDfPolicy`
  Interface for lifecycles.
  `interface`
  `IDfProcess`
  Methods you use to create and manipulate process objects, the objects that store workflow definitions in the repository.
  `interface`
  `IDfRetainer`
  Provides access to dm_retainer objects, used for defining retention applied to SysObjects.
  `interface`
  `IDfRouter`
  Deprecated.
  `interface`
  `IDfSysObjectStream`
  This class provides access to the any new public stream/content related api's for the IDfSysobject class.
  Methods in com.documentum.fc.client that return IDfSysObject
  Modifier and Type
  Method
  Description
  `IDfSysObject`
  IDfVirtualDocumentNode.`getAssemblyDocument()`
  Returns the document with which an assembly is associated.
  `IDfSysObject`
  IDfVirtualDocumentNode.`getSelectedObject()`
  Returns an IDfSysObject interface for the document represented by the node.
  `IDfSysObject`
  DfSysObjectException.`getSysObject()`
  Deprecated.
  Methods in com.documentum.fc.client with parameters of type IDfSysObject
  Modifier and Type
  Method
  Description
  `static DfSysObjectException`
  DfSysObjectException.`alreadyCallSwapRetainerException(IDfSysObject object, IDfId oldRetainerId, IDfId newRetainerId)`
  `void`
  IDfVirtualDocumentNode.`assemble(IDfSysObject object)`
  Creates an assembly for the node.
  `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.
  `protected static String`
  DfSysObjectException.`getObjectName(IDfSysObject object)`
  `protected static String`
  DfSysObjectException.`getTypeName(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newAlreadyLinkedException(IDfSysObject object, String folderSpec)`
  `static DfSysObjectException`
  DfSysObjectException.`newAssemblyParentLockedException(IDfSysObject object, String operationName)`
  `static DfSysObjectException`
  DfSysObjectException.`newBadFormat(IDfSysObject object, String formatName)`
  `static DfSysObjectException`
  DfSysObjectException.`newBindFileOfReplicaSourceUnsupported(IDfSysObject object, IDfId sourceId)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantAccessException(IDfSysObject object, String path, Throwable cause)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantAccessFileException(IDfSysObject object, String fileName)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantCheckoutNewException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantDropLabelException(IDfSysObject object, String label)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantHaveContentException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantRemoveRendition(IDfSysObject object, int page, String format)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantRemoveRendition2(IDfSysObject object, int page)`
  `static DfSysObjectException`
  DfSysObjectException.`newCantVersionLockedException(IDfSysObject object, String lockOwner)`
  `static DfSysObjectException`
  DfSysObjectException.`newCausesCycleException(IDfSysObject object, String childObjectName)`
  `static DfSysObjectException`
  DfSysObjectException.`newCircularLinkException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newCompoundDocumentEditException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newImproperStateException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newInternalLabelException(IDfSysObject object, String label)`
  `static DfSysObjectException`
  DfSysObjectException.`newInvalidPageNumberException(IDfSysObject object, int page)`
  `static DfSysObjectException`
  DfSysObjectException.`newInvalidSourceException(IDfSysObject object, String aclTypeName)`
  `static DfSysObjectException`
  DfSysObjectException.`newInvalidTypeForOperationException(IDfSysObject object, String operationName)`
  `static DfSysObjectException`
  DfSysObjectException.`newMigrateContentFailed(IDfSysObject object, String serverMessage)`
  `static DfSysObjectException`
  DfSysObjectException.`newMustHaveNameException(IDfSysObject object, String objectTypeDescription)`
  `static DfSysObjectException`
  DfSysObjectException.`newNewSaveNewException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newNoBrowseAccessException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newNoContentTypeSpecifiedException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newNoDeleteAccessException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newNoFileException(IDfSysObject object, String command)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newNoReadAccessException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newNoRelateAccessException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newNoSuchLabelException(IDfSysObject object, String label)`
  `static DfSysObjectException`
  DfSysObjectException.`newNotCheckedOutException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newNotLinkedException(IDfSysObject object, String folderSpec)`
  `static DfSysObjectException`
  DfSysObjectException.`newNotRetentionEnabledException(IDfSysObject object, String storeName)`
  `static DfSysObjectException`
  DfSysObjectException.`newNotSupportedException(IDfSysObject object, String operationName)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newNoVersionAccessException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newNoWriteAccessException(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newObjectNotCheckedOutException(IDfSysObject object, String operationName)`
  `static DfSysObjectException`
  DfSysObjectException.`newParentNotLockedException(IDfSysObject object, String operationName)`
  `static DfSysObjectException`
  DfSysObjectException.`newRenditionFormatSameAs(IDfSysObject object)`
  `static DfSysObjectException`
  DfSysObjectException.`newRetainerAlreadyAttachedException(IDfSysObject object, IDfId retainerId)`
  `static DfSysObjectException`
  DfSysObjectException.`newRetainerNotAttachedException(IDfSysObject object, IDfId retainerId)`
  `static DfSysObjectException`
  DfSysObjectException.`newSaveASNewStoreMismatchException(IDfSysObject object, String sourceDocbaseName, String targetDocbaseName, String storeName)`
  `static DfSysObjectException`
  DfSysObjectSecurityException.`newSecurityException(IDfSysObject object)`
  Constructors in com.documentum.fc.client with parameters of type IDfSysObject
  Modifier
  Constructor
  Description
  ``
  `DfAlreadyLinkedException(IDfSysObject object, String folderSpec)`
  `protected`
  `DfSysObjectException(String message, IDfSysObject object, Object[] arguments)`
  `protected`
  `DfSysObjectException(String message, IDfSysObject object, Object[] arguments, Throwable cause)`
  `protected`
  `DfSysObjectSecurityException(String message, IDfSysObject object, Object[] additionalArguments)`
  `protected`
  `DfSysObjectSecurityException(String message, IDfSysObject object, Object[] additionalArguments, Throwable cause)`

- ## Uses of IDfSysObject in com.documentum.fc.client.acs

  Subinterfaces of IDfSysObject in com.documentum.fc.client.acs
  Modifier and Type
  Interface
  Description
  `interface`
  `IDfAcsConfig`
  This interface represents ACS configuration objects.
  `interface`
  `IDfBocsConfig`
  This interface represents BOCS configuration object.
  `interface`
  `IDfContentTransferConfig`
  Distributed transfer config object
  `interface`
  `IDfDmsConfig`
  Dms config object
  `interface`
  `IDfValidationDescriptor`

- ## Uses of IDfSysObject in com.documentum.fc.client.dcis.embd

  Methods in com.documentum.fc.client.dcis.embd with parameters of type IDfSysObject
  Modifier and Type
  Method
  Description
  `void`
  IDfEmbeddingHandler.`disableEmbeddingForVirtualDoc(IDfSysObject vd)`
  This will set embedding enabled flag to false on a virtual document.
  `void`
  IDfEmbeddingHandler.`enableEmbeddingForVirtualDoc(IDfSysObject vd)`
  This will set embedding enabled flag to true on a virtual document.

- ## Uses of IDfSysObject in com.documentum.fc.client.search

  Subinterfaces of IDfSysObject in com.documentum.fc.client.search
  Modifier and Type
  Interface
  Description
  `interface`
  `IDfSearchResults`
  Represents the search results.
  `interface`
  `IDfSmartList`
  An IDfSmartList is the BOF object representing a saved search.
  Methods in com.documentum.fc.client.search with parameters of type IDfSysObject
  Modifier and Type
  Method
  Description
  `IDfSmartListDefinition`
  IDfQueryManager.`convertSmartListDefinition(IDfSysObject oldSmartList)`
  Converts smart list definition using a legacy dm_smartlist object.

- ## Uses of IDfSysObject in com.documentum.fc.lifecycle

  Methods in com.documentum.fc.lifecycle with parameters of type IDfSysObject
  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 IDfSysObject in com.documentum.operations

  Methods in com.documentum.operations that return IDfSysObject
  Modifier and Type
  Method
  Description
  `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.
  `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.
  Methods in com.documentum.operations with parameters of type IDfSysObject
  Modifier and Type
  Method
  Description
  `IDfList`
  IDfXMLUtils.`getApplicationList(IDfXMLDocType doctype, IDfSysObject object)`
  Returns a list strings containing object IDs and object names.
  `void`
  IDfCheckinNode.`setTemplate(IDfSysObject templateObject)`
  Sets the template to use when creating new object.
  `void`
  IDfImportNode.`setTemplate(IDfSysObject templateObject)`
  Sets the template to use when creating a new object.

- ## Uses of IDfSysObject in com.documentum.registry

  Methods in com.documentum.registry with parameters of type IDfSysObject
  Modifier and Type
  Method
  Description
  `IDfCheckedOutObject`
  DfClientRegistry.`addCheckedOutObject(IDfSysObject sysObject, String filePath, boolean keepLocalFile, String folderPath)`
  `IDfCheckedOutObject`
  IDfClientRegistry.`addCheckedOutObject(IDfSysObject sysObject, String filePath, boolean keepLocalFile, String folderPath)`
  Constructs a DfCheckedOutObject and writes it to the registry
  `IDfLocalObject`
  DfClientRegistry.`addLocalObject(IDfSysObject sysObject, String filePath, boolean keepLocalFile, String folderPath)`
  `IDfLocalObject`
  IDfClientRegistry.`addLocalObject(IDfSysObject sysObject, String filePath, boolean keepLocalFile, String folderPath)`
  Constructs a DfLocalObject and writes it to the registry
  `IDfViewedObject`
  DfClientRegistry.`addViewedObject(IDfSysObject sysObject, String filePath, String folderPath)`
  `IDfViewedObject`
  IDfClientRegistry.`addViewedObject(IDfSysObject sysObject, String filePath, String folderPath)`
  Constructs a DfViewedObject and writes it to the registry
  `void`
  DfClientRegistry.`applyModifiedAttrs(IDfSysObject sysObject)`
  `void`
  IDfClientRegistry.`applyModifiedAttrs(IDfSysObject sysObject)`
  updates a checked-out object's attributes with those from a sysobject
  `static void`
  DfRegistryUtils.`fillCheckedOutObject(IDfCheckedOutObject registryObject, IDfSysObject sysObject, com.documentum.operations.impl.DfOperationObject operationObject, String filePath, boolean keepLocalFile, String folderPath, com.documentum.fc.client.acs.impl.common.request.impl.ContentIdentifier contentIdentifier)`
  `static void`
  DfRegistryUtils.`fillLocalObject(IDfLocalObject registryObject, IDfSysObject sysObject, com.documentum.operations.impl.DfOperationObject operationObject, String filePath, String folderPath)`
  `static void`
  DfRegistryUtils.`fillViewedObject(IDfViewedObject registryObject, IDfSysObject sysObject, com.documentum.operations.impl.DfOperationObject operationObject, String filePath, String folderPath, com.documentum.fc.client.acs.impl.common.request.impl.ContentIdentifier contentIdentifier)`