# Package com.documentum.fc.client

package com.documentum.fc.client

Provides classes and interfaces for managing sessions and manipulating data in the repository. This package contains the most widely used interfaces in the framework and are typically the first objects instantiated and used in a DFC program. Using the interfaces in this package, one can establish a session, then perform actions like creating document objects, or creating collections of objects to perform specific tasks like starting a workflow, or attaching document lifecycles to objects.

The following list highlights functionality that can be found in this package:

    <o:p> </o:p>

       - Establishing and managing DFC sessions

       - Creating, manipulating, and retrieving data

       - Validating data

       - Managing workflows

       - Manipulating virtual documents

       - Working with document versions

       - Managing permissions

       - Creating and managing document lifecyles

       - Executing and processing queries

       - Accessing the client registry

The following example code demonstrates how to establish a session and create a document:

Java:

    <o:p> </o:p>

        // Gets a DFC local client object that will call into DMCL40.

        IDfClient client = DfClient.getLocalClient();

        IDfSessionManager sMgr = client.newSessionManager();

    <o:p> </o:p>

        // Setup login details.

        IDfLoginInfo login = new DfLoginInfo();

        login.setUser( strUserName );

        login.setPassword( strPassword );

        login.setDomain( null );

    <o:p> </o:p>

        sMgr.setIdentity( strDocbase1, login );

        sMgr.setIdentity( strDocbase2, login );

    <o:p> </o:p>

        IDfSession session1 = sMgr.newSession( strDocbase1 );

    <o:p> </o:p>

        // Create a document.

        IDfDocument document = null;

        document = (IDfDocument) session1.newObject("dm_document");

        document.setObjectName("Report on Literature");

        document.setContentType("crtext");

        document.setFile("C:/Temp/Lit.txt");

        document.save();

To access Java, Visual Basic and C++ DFC sample code, please visit the Documentum Developer Program.

- Related Packages
  Package
  Description
  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.mq
  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).
- Class
  Description
  DfACLException
  An exception that occurs when operating on a IDfACL instance.
  DfAlreadyLinkedException
  DfAspectOperationException
  DfAttributeValueException
  DfAuthenticationException
  Signals a problem with authentication of an identity.
  DfClient
  An implementation of the IDfClient interface for use in a basic Java environment.
  DfContentAreaException
  DfDborNotFoundException
  This exception is used to indicate that the DBOR was not found
  DfDeadlockException
  DfDefaultSessionManagerEventListener
  DfDefaultTrustManager
  A default implementation of `IDfTrustManager` that manages trust credentials in the form of properties that can be configured in a file.
  DfDocbaseUnreachableException
  DfDocbrokerException
  DfDocbrokerRuntimeException
  DfDuplicateAspectException
  DfIdentityException
  This exception is thrown when a specific docbase does not have an identity.
  DfIdNotFoundException
  Thrown when a requested Docbase object can not be found.
  DfIOException
  Signals that an I/O exception of some sort has occurred while communicating with the docbase.
  DfNameNotFoundException
  Thrown when a requested Docbase object can not be found.
  DfNoMatchException
  Thrown when a qualification failed to match an object.
  DfNonExistentAspectException
  DfNoServersException
  DfObjectNotFoundException
  Thrown when a requested Docbase object can not be found.
  DfOutOfServerSessionsException
  DfOutOfSessionsException
  DfPathNotFoundException
  Thrown when a requested Docbase object can not be found.
  DfPersistentObjectException
  DfPreferenceException
  An exception that occurs when operating on a IDfTypedObject instance.
  DfPrincipalException
  An exception that signals a problem with principal authentication.
  DfRestrictedAccessException
  Signals a restricted session.
  DfScopingException
  DfScopingException class.
  DfService
  The superclass for all service-based business objects.
  DfServiceCriticalException
  This exception is no longer used.
  DfServiceException
  This class provides error information.
  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.
  DfServiceNotFoundException
  This exception is thrown when a Business Object Service is not configured in DBOR (Documentum Business Object registry).
  DfStaleSessionHandleException
  Thrown when the session referenced by a handle no longer exists.
  DfSysObjectException
  An exception that occurs when operating on a IDfSysObject instance.
  DfSysObjectSecurityException
  DfTypedObjectException
  An exception that occurs when operating on a IDfTypedObject instance.
  DfUserAliasSetNotFoundException
  DfUserException
  DfWorkflowException
  Exceptions that occur when operating on workflow runtime objects including IDfWorkflow, IDfWorkitem, IDfPackage
  IDfACL
  Provides access to permission-related data stored in ACL objects.
  IDfActivity
  This interface provides functions to access objects of dm_activity type.
  IDfAdminClient
  An extension of `IDfClient` that is useful for administrative programs.
  IDfAliasSet
  Provides access to business policy aliasing-related data stored in dm_alias_set objects.
  IDfAspectRelation
  This interface provides access to permission-related data stored in ACL objects.
  IDfAssembly
  This class provides the functionality to interact with dm_assembly objects in the repository.
  IDfAuditData
  IDfAuditTrail
  IDfAuditTrailManager
  The Documentum server can log the occurrence of a predefined set of events to the audit trail.
  IDfBatchGroup
  This interface describes the batch group object used in batch inserts.
  IDfBatchManager
  This interface provides the functionality for insert batching.
  IDfBusinessObject
  A standard administrative interface that all BOF objects must implement.
  IDfClient
  This interface provides functionality to establish and manage sessions with a Documentum server, and provides information about the server before a session is established.
  IDfCollection
  This interface provides access to collection objects.
  IDfContainment
  Provides the functionality to interact with dmr_containment objects in the repository.
  IDfContentCollection
  IDfDbor
  Used to manage the Documentum Business Objects Registry (DBOR), provide methods to register and unregister business objects, and to look up registered business object entries in DBOR.
  IDfDborEntry
  Allows you to define service properties for DBOR.
  IDfDocbaseMap
  This interface provides information about the repositories known to a connection broker.
  IDfDocbrokerClient
  An interface for interacting with connection brokers for the purpose of obtaining lists of repositories and repository servers.
  IDfDocument
  Provides the functionality for the client to interact with "dm_document" objects in the respository.
  IDfDumpRecord
  Interface for getting and setting values for dm_dump_record objects.
  IDfEnumeration
  Provides a wrapper for a java.util.Enumeration so that it may be used across COM.
  IDfEventManager
  During batch insert, mulitple events would be written into one queue item if oneEventPerBatch were specified.
  IDfFolder
  This interface provides access to folder-related data stored in folder objects.
  IDfForeignKey
  IDfFormat
  Provides access to format information.
  IDfGetObjectOptions
  This interface encapsulates options to get an object from the repository.
  IDfGlobalModuleRegistry
  IDfGroup
  This interface provides access to group-related data stored in group objects.
  IDfLightObject
  Provides access to lightobject related functionality.
  IDfLoadRecord
  Interface for getting and setting values for dm_load_record objects.
  IDfLocalModuleRegistry
  IDfLocalTransaction
  This is a marked interface to represent a local transaction.
  IDfLocation
  This interface provides access to location properties.
  IDfMethodObject
  IDfModule
  IDfModuleCategory
  IDfModuleDescriptor
  IDfModuleFilter
  IDfModuleRegistry
  IDfMountPoint
  This interface provides access to mount point-related data stored in dm_mount_point objects.
  IDfNetworkLocationEntry
  IDfNote
  This class provides the functionality for the client to interact with "dm_sysobject" objects in the repository.
  IDfObjectPath
  Representation of user-accessible path to a given object.
  IDfObjectPathsMap
  A map where the key are objects id and the values are an enumeration of the path where the object is located.
  IDfPackage
  Interface definition for the type DmiPackage Description: This object cannot be saved.
  IDfPermit
  This class provides the interface for defining and viewing security permits applied to documents and ACLs.
  IDfPermitType
  Constant definitions for types of permits used with `IDfPermit`.
  IDfPermitTypeString
  Constant String definitions for types of permits used with `IDfPermit`.
  IDfPersistentObject
  A Documentum object that has typed attributes and is persisted in a repository.
  IDfPlugin
  This interface provides access to plugin-related data stored in dm_plugin objects.
  IDfPolicy
  Interface for lifecycles.
  IDfPredicate
  A predicate is an object which evaluates a boolean condition given some runtime state.
  IDfPrincipalSupport
  An interface supported by classes that can establish sessions using principal-mode authentication.
  IDfProcess
  Methods you use to create and manipulate process objects, the objects that store workflow definitions in the repository.
  IDfQuery
  This interface provides functionality for running queries against a repository.
  IDfQueueItem
  This interface contains the functionality to retrieve information from a dmi_queue_item object.
  IDfRelation
  Interface definition for the type dm_relation Description:
  IDfRelationType
  Interface definition for the type dm_relation_type.
  IDfRetainer
  Provides access to dm_retainer objects, used for defining retention applied to SysObjects.
  IDfRetainerDispositionRule
  Defines the way in which disposition rules are enforced.
  IDfRetainerEnforcementRule
  Defines the way in which retention protection rules are enforced.
  IDfRetainerFactory
  This class provides calls to create dmRetainer objects.
  IDfRetainerImmutabilityRule
  Defines updateability rules for objects under retention.
  IDfRetainerRenditionRule
  Defines how retention applies to the content of an object under retention control.
  IDfRetainerStrategy
  Defines possible retainer strategy values for the IDfRetainer class.
  IDfRetentionRuleType
  Defines the retention rule type for the IDfRetainer class.
  IDfRetentionService
  This class provides access to retention operations.
  IDfRetentionStatus
  Defines the possible status values of an IDfRetainer object.
  IDfRouter
  Deprecated.
  IDfScope
  IDfScopeManager
  IDfSeekRoot
  Constants for specifying the root location of a `IDfContentCollection.seek(int, int)` operation.
  IDfServerMap
  Provides information about known Docbase Servers.
  IDfService
  Parent interface for all service-based business objects.
  IDfSession
  This interface encapsulates a session with a Documentum repository.
  IDfSessionManager
  Manages identities, pooled sessions and transactions.
  IDfSessionManagerConfig
  IDfSessionManagerEventListener
  Allows a client to subscribe to major Session Manager events
  IDfSessionManagerStatistics
  Provides statistics and status related to a session manager instance.
  IDfSessionScopeManager
  IDfStateExtension
  Interface for policy state extensions.
  IDfSysObject
  This class provides the functionality for the client to interact with "dm_sysobject" objects in the repository.
  IDfSysObjectRetention
  This class provides access to the retention operations of the IDfSysobject class.
  IDfSysObjectStream
  This class provides access to the any new public stream/content related api's for the IDfSysobject class.
  IDfTrustManager
  An interface for obtaining Content server trust credentials.
  IDfType
  This interface provides access to type-related data stored in type objects.
  IDfTypedObject
  Public operations for all typed objects.
  IDfTypeInfo
  IDfUser
  This interface provides access to user-related data stored in user objects.
  IDfValidator
  Interface that provides the data validation functionality.
  IDfValueAssistance
  Interface to provide information about the value assistance of an attribute, given the set of attribute name/value pairs of its depending attributes.
  IDfVDMNumberingScheme
  This interface provides functionality used to manage hierarchy numbers for virtual documents displayed in the Virtual Document Manager.
  IDfVersionLabels
  This class is used to enumerate the possible values of implicit and symbolic version labels for a SysObject.
  IDfVersionPolicy
  This interface provides version-related information about SysObjects.
  IDfVersionTreeLabels
  This interface provides information about the version tree of a SysObject.
  IDfVirtualDocument
  This class contains the functionality to manage virtual documents.
  IDfVirtualDocumentNode
  This interface provides access to the nodes in a virtual document tree displayed in the Virtual Document Manager.
  IDfWorkflow
  This interface provides methods that allow you to create, start, and manage a workflow.
  IDfWorkflowAttachment
  Interface definition for the type DmiWFAttachment.
  IDfWorkflowBuilder
  This interface provides methods to help start a workflow.
  IDfWorkitem
  This interface contains the methods to manage work items, the runtime objects that represent the tasks associated with activity instances in a workflow.
  InvocationException
  IStorageRuleEvaluator
  This interface provides methods for evaluating storage policy rules