Package | Description |
---|---|
com.documentum.com |
Provides an interface for accessing the DFC through OLE/COM.
|
com.documentum.fc.client |
Provides classes and interfaces for managing sessions and manipulating data in the repository. |
com.documentum.fc.client.acs |
Provides classes and interfaces, related to distributed content transfer.
|
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.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 |
Modifier and Type | Method and Description |
---|---|
IDfFormatRecognizer |
IDfClientX.getFormatRecognizer(IDfSession session,
java.lang.String filePath,
java.lang.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. |
IDfFormatRecognizer |
DfClientX.getFormatRecognizer(IDfSession session,
java.lang.String filePath,
java.lang.String suggestedFormat) |
IDfFormatRecognizer |
IDfClientX.getMacFormatRecognizer(IDfSession session,
java.lang.String dataForkpath,
java.lang.String resourceForkPath,
java.lang.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. |
IDfFormatRecognizer |
DfClientX.getMacFormatRecognizer(IDfSession session,
java.lang.String dataForkPath,
java.lang.String resForkPath,
java.lang.String suggestedFormat) |
com.documentum.fc.client.relationship.IDfRelationshipSchema |
IDfSmartClientX.getRelationshipSchema(IDfSession session) |
IDfVirtualDocumentNode |
IDfClientX.getVirtualDocumentNodeFromToken(IDfSession session,
java.lang.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.
|
IDfVirtualDocumentNode |
DfClientX.getVirtualDocumentNodeFromToken(IDfSession session,
java.lang.String token) |
Modifier and Type | Method and Description |
---|---|
IDfSession |
IDfClient.adoptDMCLSession(java.lang.String dmclSessionId)
Deprecated.
session adoption is no longer useful without a separate DMCL
|
IDfSession |
DfClient.adoptDMCLSession(java.lang.String dmclSessionId) |
IDfSession |
IDfClient.findSession(java.lang.String sessionId)
Returns an existing DFC session using a DFC session ID.
|
IDfSession |
DfClient.findSession(java.lang.String sessionId) |
IDfSession |
IDfTypedObject.getObjectSession()
Gets the session to the Docbase containing the object.
|
IDfSession |
IDfTypedObject.getOriginalSession()
Gets the session through which the object was originally requested.
|
IDfSession |
IDfSession.getRelatedSession(IDfId objectId)
Returns a related session appropriate for operating on the given object id.
|
IDfSession |
IDfSession.getRelatedSession(java.lang.String docbaseSpecString)
Returns a related session to a named docbase.
|
IDfSession |
IDfTypedObject.getSession()
Gets the session through which the object was originally requested.
|
IDfSession |
IDfSessionManager.getSession(java.lang.String docbase)
To get the session handle a service implementation should call the
getSession method. |
IDfSession |
IDfService.getSession(java.lang.String docbase)
Returns a previously established "managed"
IDfSession
object. |
IDfSession |
DfService.getSession(java.lang.String docbaseName)
Obtains a handle to a Docbase session.
|
IDfSession |
IDfPrincipalSupport.getSession(java.lang.String docbaseName,
java.lang.String principalName)
Retrieves a session for a given principal and repository.
|
IDfSession |
IDfClient.getSharedSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo,
java.lang.String key)
Deprecated.
use
IDfSessionManager instead for session sharing |
IDfSession |
DfClient.getSharedSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo,
java.lang.String key) |
IDfSession |
IDfSessionManager.newSession(java.lang.String docbase)
To get a new instance of a DFC session,
newSession retrieves a new session for the given repository. |
IDfSession |
IDfClient.newSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo)
Factory method that always constructs a new
IDfSession object and establishes a new session with the
specified Documentum server. |
IDfSession |
DfClient.newSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
IStorageRuleEvaluator.evaluate(IDfSysObject sysObj,
com.documentum.fc.client.DfContentInfo contentInfo,
IDfSession session,
java.lang.Object obj)
This method is used to evaluate the rules in the policy.
|
IDfCollection |
IDfQuery.execute(IDfSession session,
int queryType)
Executes a DQL query.
|
java.lang.Class |
DfClient.getModuleClass(java.lang.String moduleName,
IDfSession session) |
int |
IDfSessionManagerStatistics.getReferenceCount(IDfSession session)
Get the reference count for a given session.
|
IDfRetainer |
IDfRetainerFactory.newRetainerForContainerId(IDfSession session,
IDfId rootObjectId)
Creates IDfRetainer to apply retention to a group of objects.
|
IDfRetainer |
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 |
IDfService.releaseSession(IDfSession session)
Releases the "managed" session back to the session pool.
|
void |
DfService.releaseSession(IDfSession session)
Releases a handle to a Docbase session.
|
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.
|
Modifier and Type | Method and Description |
---|---|
IDfEnumeration |
IDfAcsClient.getAcsData(IDfSession session,
java.lang.String networkLocationIdentifier)
Returns an
IDfEnumeration object that lists all
AcsData objects for a given repository. |
boolean |
IDfAcsClient.isContentTransferCapabilityEnabled(IDfSession session,
java.lang.String networkLocationIdentifier,
IDfContentTransferCapability capability)
Returns whether content transfer capability is enabled in a docbase
of a given session.
|
Modifier and Type | Method and Description |
---|---|
IDfCollection |
IDfSearchStoreService.getAllSearches(IDfSession session)
Returns all searches from this repository, including
all of the user's searches and any shared searches.
|
IDfCollection |
IDfSearchStoreService.getCurrentUserSearches(IDfSession session)
Returns only the user's searches from this repository.
|
Modifier and Type | Method and Description |
---|---|
IDfSession |
IDfOperation.getSession()
Returns session to be used during operation execution
|
IDfSession |
IDfImportOperation.getSession()
Returns session to be used to import new objects.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfXMLUtils.setSession(IDfSession session)
Set the session that will be used by the class.
|
void |
IDfXMLTransformOperation.setSession(IDfSession session)
Set the session that will be used by this operation.
|
void |
IDfXMLTransformNode.setSession(IDfSession session)
Set the session that will be used by this operation.
|
void |
IDfOperation.setSession(IDfSession session)
Sets the session that will be used during operation execution.
|
void |
IDfImportOperation.setSession(IDfSession importSession)
Sets the session that will be used to create new docbase objects.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfClientRegistry.moveToLocalFiles(IDfCheckedOutObject object,
IDfSession session)
Removes a checked out file and places it in the list of local files.
|
Modifier and Type | Method and Description |
---|---|
void |
IDfXmlQuery.execute(int mode,
IDfSession session)
Executes the DQL query and creates a DOM.
|
void |
IDfXmlQuery.execute(java.lang.String mode,
IDfSession session)
Deprecated.
Since 5.1.
This method is deprecated to make usage consistent across the IDfXmlQuery and IDfQuery interfaces. |
Modifier and Type | Method and 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.
|
java.lang.String |
IDfXQuery.getDebugInfo(IDfSession session,
IDfXQuery.FtQueryDebugOptions debugOption)
Retrieve debugging information associated with this query
|
java.lang.String |
IDfXQuery.getExecutionPlan(IDfSession session)
Retrieve the xquery execution plan from ESS after the query is executed.
|
java.io.InputStream |
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.
|
Copyright 1994-2023 OpenText Corporation. All rights reserved.