Uses of Interface
com.documentum.fc.client.IDfSession
Packages that use IDfSession
Package
Description
Provides an interface for accessing the DFC through OLE/COM.
Provides classes and interfaces, related to distributed content transfer.
Provides classes and interfaces for constructing and running search queries against
multiple content repositories as well as external information sources (optional).
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.
Provides interfaces and classes that manage Documentum
information on the client’s local system.
Provides interfaces and classes that allow querying of the docbase with
results returned as XML.
-
Uses of IDfSession in com.documentum.com
Methods in com.documentum.com with parameters of type IDfSessionModifier and TypeMethodDescriptionDfClientX.getFormatRecognizer
(IDfSession session, String filePath, String suggestedFormat) IDfClientX.getFormatRecognizer
(IDfSession session, String filePath, String suggestedFormat) Factory method that constructs a newIDfFormatRecognizer
object that is used to suggest what Docbase formats might be appropriate for the specified file.DfClientX.getMacFormatRecognizer
(IDfSession session, String dataForkPath, String resForkPath, String suggestedFormat) IDfClientX.getMacFormatRecognizer
(IDfSession session, String dataForkpath, String resourceForkPath, String suggestedFormat) Factory method that constructs a newIDfFormatRecognizer
object that is used to suggest what Docbase formats might be appropriate based on both the data and resource forks of a Macintosh file.com.documentum.fc.client.relationship.IDfRelationshipSchema
IDfSmartClientX.getRelationshipSchema
(IDfSession session) DfClientX.getVirtualDocumentNodeFromToken
(IDfSession session, String token) 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. -
Uses of IDfSession in com.documentum.fc.client
Methods in com.documentum.fc.client that return IDfSessionModifier and TypeMethodDescriptionDfClient.adoptDMCLSession
(String dmclSessionId) IDfClient.adoptDMCLSession
(String dmclSessionId) Deprecated.session adoption is no longer useful without a separate DMCLDfClient.findSession
(String sessionId) IDfClient.findSession
(String sessionId) Returns an existing DFC session using a DFC session ID.IDfTypedObject.getObjectSession()
Gets the session to the Docbase containing the object.IDfTypedObject.getOriginalSession()
Gets the session through which the object was originally requested.IDfSession.getRelatedSession
(IDfId objectId) Returns a related session appropriate for operating on the given object id.IDfSession.getRelatedSession
(String docbaseSpecString) Returns a related session to a named docbase.DfService.getSession
(String docbaseName) Obtains a handle to a Docbase session.IDfPrincipalSupport.getSession
(String docbaseName, String principalName) Retrieves a session for a given principal and repository.IDfService.getSession
(String docbase) Returns a previously established "managed"IDfSession
object.IDfSessionManager.getSession
(String docbase) To get the session handle a service implementation should call thegetSession
method.IDfTypedObject.getSession()
Gets the session through which the object was originally requested.DfClient.getSharedSession
(String docbaseName, IDfLoginInfo loginInfo, String key) IDfClient.getSharedSession
(String docbaseName, IDfLoginInfo loginInfo, String key) Deprecated.useIDfSessionManager
instead for session sharingDfClient.newSession
(String docbaseName, IDfLoginInfo loginInfo) IDfClient.newSession
(String docbaseName, IDfLoginInfo loginInfo) Factory method that always constructs a newIDfSession
object and establishes a new session with the specified Documentum server.IDfSessionManager.newSession
(String docbase) To get a new instance of a DFC session,newSession
retrieves a new session for the given repository.Methods in com.documentum.fc.client with parameters of type IDfSessionModifier and TypeMethodDescriptionIStorageRuleEvaluator.evaluate
(IDfSysObject sysObj, com.documentum.fc.client.DfContentInfo contentInfo, IDfSession session, Object obj) This method is used to evaluate the rules in the policy.IDfQuery.execute
(IDfSession session, int queryType) Executes a DQL query.DfClient.getModuleClass
(String moduleName, IDfSession session) int
IDfSessionManagerStatistics.getReferenceCount
(IDfSession session) Get the reference count for a given session.IDfRetainerFactory.newRetainerForContainerId
(IDfSession session, IDfId rootObjectId) Creates IDfRetainer to apply retention to a group of objects.IDfRetainerFactory.newRetainerForObjectId
(IDfSession session, IDfId rootObjectId) Creates IDfRetainer to apply retention to a single object.void
IDfSessionManagerEventListener.onSessionCreate
(IDfSession session) This method is called only when session manager has to create a new session object.void
IDfSessionManagerEventListener.onSessionDestroy
(IDfSession session) Deprecated.void
IDfSessionManager.release
(IDfSession session) Puts the DFC session object back into the session pool.void
DfService.releaseSession
(IDfSession session) Releases a handle to a Docbase session.void
IDfService.releaseSession
(IDfSession session) Releases the "managed" session back to the session pool.void
IDfVirtualDocument.resync
(IDfSession session, IDfId objectId, int flags) Flushes all node information and synchronizes cached object attributes with the repository.void
IDfDocbrokerClient.setDocbrokerModificationEnabled
(boolean enable, IDfSession session) Enables or disables the dynamic adding and removing of connection brokers. -
Uses of IDfSession in com.documentum.fc.client.acs
Methods in com.documentum.fc.client.acs with parameters of type IDfSessionModifier and TypeMethodDescriptionIDfAcsClient.getAcsData
(IDfSession session, String networkLocationIdentifier) Returns anIDfEnumeration
object that lists allAcsData
objects for a given repository.boolean
IDfAcsClient.isContentTransferCapabilityEnabled
(IDfSession session, String networkLocationIdentifier, IDfContentTransferCapability capability) Returns whether content transfer capability is enabled in a docbase of a given session. -
Uses of IDfSession in com.documentum.fc.client.search
Methods in com.documentum.fc.client.search with parameters of type IDfSessionModifier and TypeMethodDescriptionIDfSearchStoreService.getAllSearches
(IDfSession session) Returns all searches from this repository, including all of the user's searches and any shared searches.IDfSearchStoreService.getCurrentUserSearches
(IDfSession session) Returns only the user's searches from this repository. -
Uses of IDfSession in com.documentum.operations
Methods in com.documentum.operations that return IDfSessionModifier and TypeMethodDescriptionIDfImportOperation.getSession()
Returns session to be used to import new objects.IDfOperation.getSession()
Returns session to be used during operation executionMethods in com.documentum.operations with parameters of type IDfSessionModifier and TypeMethodDescriptionvoid
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
IDfXMLUtils.setSession
(IDfSession session) Set the session that will be used by the class. -
Uses of IDfSession in com.documentum.registry
Methods in com.documentum.registry with parameters of type IDfSessionModifier and TypeMethodDescriptionvoid
IDfClientRegistry.moveToLocalFiles
(IDfCheckedOutObject object, IDfSession session) Removes a checked out file and places it in the list of local files. -
Uses of IDfSession in com.documentum.xml.xdql
Methods in com.documentum.xml.xdql with parameters of type IDfSessionModifier and TypeMethodDescriptionvoid
IDfXmlQuery.execute
(int mode, IDfSession session) Executes the DQL query and creates a DOM.void
IDfXmlQuery.execute
(String mode, IDfSession session) Deprecated.Since 5.1.
This method is deprecated to make usage consistent across the IDfXmlQuery and IDfQuery interfaces. -
Uses of IDfSession in com.documentum.xml.xquery
Methods in com.documentum.xml.xquery with parameters of type IDfSessionModifier and TypeMethodDescriptionvoid
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.IDfXQuery.getDebugInfo
(IDfSession session, IDfXQuery.FtQueryDebugOptions debugOption) Retrieve debugging information associated with this queryIDfXQuery.getExecutionPlan
(IDfSession session) Retrieve the xquery execution plan from ESS after the query is executed.IDfXQuery.getInputStream
(IDfSession session) Return an InputStream object that applications can use it to retrieve the xquery results.int
IDfXQuery.readResults
(byte[] buffer, IDfSession session) Fills the given buffer with the next set of XQuery results.