Class DfClientX
- All Implemented Interfaces:
IDfClientX
,Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionConverts a JavaByteArrayInputStream
object into a String.void
Close the DFC trace output.deserializeObject
(String image) Restores the object from its serialized image.void
Flushes the DFC trace output.Returns anIDfAcsClient
object.Factory method that constructs a newIDfAcsTransferPreferences
instance.Factory method that constructs a newIDfCancelCheckout
object.Factory method that constructs a newIDfCheckinOperation
object for checking in one or more checked out repository objects.Factory method that constructs a newIDfCheckoutOperation
object for checking in one or more repository objects previously checked out.Factory method that constructs a newIDfClientRegistry
object that provides access to the Docbase object information stored on the local system.com.documentum.operations.contentpackage.IDfContentPackageFactory
Factory method that returns a handle toIDfContentPackageFactory
object.Factory method that constructs a newIDfCopyOperation
object.Factory method that constructs a newIDfDborEntry
object.Factory method that constructs a newIDfDeleteOperation
object.Returns the current DFC version string.Factory method that contructs a newIDfDocbrokerClient
instance.Factory method for anIDfEnumeration
object.Factory method for anIDfEnumeration
object.Factory method that constructs a newIDfExportOperation
object for exporting one or more repository objects to the file system.Factory method that constructs a newIDfFile
object that represents a file system file.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.Factory method for anIDfGetObjectOptions
object.Factory method for anIDfId
object.Factory method that constructs a newIDfImportOperation
object for importing one or more files into the repository.getList()
Factory method for anIDfList
object.Factory method for anIDfClient
object.Returns a DFC local client object that will call into DMCL32.dll for backward compatibility with pre-4.0 Documentum servers.com.documentum.djcb.IDfLogger
Factory method for anIDfLoginInfo
object.getMacFormatRecognizer
(IDfSession session, String dataForkPath, String resForkPath, 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.Factory method that constructs a newIDfMoveOperation
object.getOperation
(String operationName) Factory method for creating a new operation object.Factory method that contructs a newIDfPermit
object.Factory method that constructs a newIDfPredictiveCachingOperation
object for predictive content caching.Factory method that constructs a new emptyIDfProperties
object that provides functionality for manipulating values in a hashable.getQuery()
Factory method for anIDfQuery
object.com.documentum.fc.client.qb.IDfQueryMgr
Factory method that constructs a newIDfQueryMgr
object that is used for configuring and sending complex DQL queries to Documentum servers using the query builder objects located in thecom.documentum.fc.client.qb
package.Factory method for anIDfTime
object.Returns the current DFC trace filename.int
Returns the current DFC trace level.com.documentum.djcb.IDfTracer
boolean
Returns if the current DFC trace contains threading information.boolean
Returns if the current DFC trace contains timing information.Factory method that constructs a newIDfValidationOperation
object.getVirtualDocument
(IDfSysObject rootObject, String lateBindingValue, boolean followRootAssembly) Returns a virtual document object where the providedIDfSysObject
is the root object of the virtual document.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.Factory method that contructs a newIDfXMLDocType
object.Factory method that constructs a newIDfXmlQuery
object.Factory method that constructs a newIDfTransformOperation
object for using XSLT to transform one or more XML documents into another form, such as HTML, PDF, etc.Factory method that constructs a newIDfXMLUtils
object that provides methods for XML related functions, likegetApplicationByDTD, getObjectIdFromDRL , isXML, isHTML,
and so on.Factory method that constructs a newIDfXQuery
object.com.documentum.xml.xquery.IDfXQueryTargets
getXQueryTargets
(int targetCategory) Factory method that constructs a newIDfXQueryTargets
object.parseException
(String streamedExc) Turns a string returned by OLE/COM exception into anIDfException
object.serializeObject
(Object object) Serializes an object.void
setTraceFileName
(String fileName) Redirects the trace output to the specified file.void
setTraceLevel
(int level) Turns on DFC tracing when level is greater than 0.void
setTraceThreads
(boolean fEnable) Sets the DFC trace to contain threading information.void
setTraceTime
(boolean fEnable) Set the DFC trace to contain timing information.Converts a String into a JavaByteArrayOutputStream
object.void
Print a message to the DFC trace output.void
traceMsgCond
(int triggerLevel, String msg) Conditionally print a message to the trace output.
-
Constructor Details
-
DfClientX
public DfClientX()
-
-
Method Details
-
getLocalClient
Description copied from interface:IDfClientX
Factory method for anIDfClient
object. Returns a DFC local client object that will call into DMCL40.dll to connect to the Documentum servers. This method call will precede the calls to connect to the Documentum server (IDfClient.newSession(), IDfClient.getSharedSession()
). Calling this method after the first call merely returns a reference to the sameIDfClient
object returned from the first call. There is no penalty for calling this method more than once in a program.The following code examples demonstrate how to obtain an
IDfClient
interface:
Java:IDfClientX clientx = new DfClientX(); IDfClient client = DfClient.getLocalClient(); // Login details are then setup here... // Then a session is established with the Documentum server... IDfSessionManager sMgr = client.newSessionManager(); sMgr.setIdentity( strDocbaseName, loginInfo ); IDfSession session = sMgr.getSession( strDocbaseName );
Visual Basic:Dim clientx As New DfClientX Dim client As IDfClient Dim sMgr as IDfSessionManager Dim session As IDfSession Set client = clientx.getLocalClient Set sMgr as client.getSessionManager ' Login details are then setup here... ' Then a session is established with the Documentum server... sMgr.setIdentity( strDocbaseName ) Set session = sMgr.getSession( strDocbaseName )
- Specified by:
getLocalClient
in interfaceIDfClientX
- Returns:
- a DFC local client object.
- Throws:
DfException
- an error object with an error codeDM_DFC_E_INIT_DMCL
indicating DMCL40.dll could not be loaded.- See Also:
-
getLoginInfo
Description copied from interface:IDfClientX
Factory method for anIDfLoginInfo
object. Constructs a new empty object to set with login details prior to connecting to Documentum servers.The following code example demonstrates how to obtain an
IDfLoginInfo
interface, set login details then connect to a Documentum server:
Visual Basic:Dim clientx As New DfClientX Dim client As IDfClient Dim sMgr as IDfSessionManager Dim loginInfoObj As IDfLoginInfo Dim session As IDfSession Set client = clientx.getLocalClient sMgr = client.newSessionManager Set loginInfoObj = clientx.getLoginInfo loginInfoObj.setUser "dbuser" loginInfoObj.setPassword "dbpass" sMgr.setIdentity( "docbaseName", loginInfoObj ) Set session = sMgr.getSession( "docbaseName" )
- Specified by:
getLoginInfo
in interfaceIDfClientX
- Returns:
- an
IDfLoginInfo
interface to a new emptyDfLoginInfo
object - See Also:
-
getQuery
Description copied from interface:IDfClientX
Factory method for anIDfQuery
object. Constructs an new query object to use for sending DQL queries to Documentum servers.The following code example demonstrates how to obtain an
IDfQuery
interface, set a DQL query to the object and execute the query:
Java:
Visual Basic:IDfClient client = new DfClient(); IDfClientX clientx = new DfClientX(); IDfQuery query = clientx.getQuery(); query.setDQL( "select * from dm_cabinet" ); IDfCollection coll = query.execute( session, IDfQuery.DF_READ_QUERY );
Dim clientx As New DfClientX Dim query as IDfQuery Dim coll as IDfCollection Set query = clientx.getQuery query.setDQL "select * from dm_cabinet" Set coll = query.execute(session, DFCLib.IDfQuery.DF_READ_QUERY)
- Specified by:
getQuery
in interfaceIDfClientX
- Returns:
- an
IDfQuery
interface to a query object.
-
getGetObjectOptions
Description copied from interface:IDfClientX
Factory method for anIDfGetObjectOptions
object. Constructs a new option object to use with getObjectWithOptions.The following code example demonstrates how to obtain an
IDfGetObjectOptions
interface, set object options and call getObjectWithOptions.
Java:IDfClientX clientx = new DfClientX(); IDfGetObjectOptions objectOptions = clientx.getGetObjectOptions(); //Set object with values for partitionid,typeName, cachePersistently, and currencyCheckValue. //By default, the values are -1, null, false and null. objectOptions.setPartition(1,"dm_document"); //for example, partitionid value is 1 // and type name needs to be the exact // object type name, not any super type name IDfPersistentObject perObj = sess.getObjectwithOptions(idObj,objectOptions); if (perObj.getObjectId().getId().equals("0900d5bb8001f900")) { // Successfully fetched object... }
- Specified by:
getGetObjectOptions
in interfaceIDfClientX
- Returns:
- an
IDfGetObjectOptions
interface to a new empty object options.
-
getXmlQuery
Description copied from interface:IDfClientX
Factory method that constructs a newIDfXmlQuery
object.- Specified by:
getXmlQuery
in interfaceIDfClientX
- Returns:
- a new
IDfXmlQuery
object. - See Also:
-
getXQuery
Description copied from interface:IDfClientX
Factory method that constructs a newIDfXQuery
object.- Specified by:
getXQuery
in interfaceIDfClientX
- Returns:
- a new
IDfXQuery
object. - See Also:
-
getDborEntry
Description copied from interface:IDfClientX
Factory method that constructs a newIDfDborEntry
object.- Specified by:
getDborEntry
in interfaceIDfClientX
- Returns:
- a new
IDfDborEntry
object. - See Also:
-
serializeObject
Description copied from interface:IDfClientX
Serializes an object. It is used for passing the object across process boundaries.- Specified by:
serializeObject
in interfaceIDfClientX
- Parameters:
object
- object to serialize- Returns:
- the serialized object
-
deserializeObject
Description copied from interface:IDfClientX
Restores the object from its serialized image.- Specified by:
deserializeObject
in interfaceIDfClientX
- Parameters:
image
- serialized object- Returns:
- the deserialized object
- Throws:
DfException
-
getList
Description copied from interface:IDfClientX
Factory method for anIDfList
object. Constructs a newIDfList
object representing an empty list to fill with data. DFC applications should always use anIDfList
object instead of ajava.util.List
object.The following code example demonstrates how to obtain an
IDfList
interface and insert a value into the list:
Java:IDfClientX clientx = new DfClientX() IDfList listString = clientx.getList(); if( listStrings.getCount() == 0 ) { // The list is correctly empty... } listStrings.insertString( "stringVal" ); if( listStrings.getCount == 1 ) { // Item added correctly... }
Visual Basic:Dim clientx As New DfClientX Dim listStrings As IDfList Set listStrings = clientx.getList If listStrings.getCount = 0 Then ' The list is correctly empty... End If listStrings.insertString "stringVal" If listStrings.getCount = 1 Then ' Item added correctly... End If
- Specified by:
getList
in interfaceIDfClientX
- Returns:
- an
IDfList
interface to a new list object. - See Also:
-
getProperties
Description copied from interface:IDfClientX
Factory method that constructs a new emptyIDfProperties
object that provides functionality for manipulating values in a hashable. DFC applications should always use anIDfProperties
object instead of ajava.util.Hashtable
object.- Specified by:
getProperties
in interfaceIDfClientX
- Returns:
- an
IDfProperties
interface
-
getId
Description copied from interface:IDfClientX
Factory method for anIDfId
object. Constructs a newIDfId
object representing an object id of an object in the Documentum server.The following code example demonstrates how to obtain an
IDfId
interface:Dim clientx As New DfClientX Dim id As IDfId Set id = clientx.getId("0900d5bb8001fd00") If id.toString = "0900d5bb8001fd00" Then ' Do something here... End If
- Specified by:
getId
in interfaceIDfClientX
- Parameters:
id
- the object id of an object in the Documentum server.- Returns:
- an
IDfId
an interface to an object id. - See Also:
-
getTime
Description copied from interface:IDfClientX
Factory method for anIDfTime
object. Constructs a new time object initialized to the time and format pattern provided by the user. If you want to get an IDfTime instance representing the NULLDATE, pass an empty string ("") for both parameters.The following code example demonstrates how to obtain an
IDfTime
interface:Dim clientx As New DfClientX Dim t As IDfTime Set t = clientx.getTime("09/09/2000 12:12:47", "mm/dd/yyyy hh:mi:ss")
- Specified by:
getTime
in interfaceIDfClientX
- Parameters:
time
- the time to initialize the object to.pattern
- defines the pattern that you want to use to interpret the value of time. If a pattern is empty, the value is interpreted using the client's short date format if that is defined. The valid patterns are:- mm/dd/[yy]yy
- dd-mon-[yy]yy
- month dd[,] [yy]yy
- mon dd [yy]yy
- [dd/]mm/[yy]yy
- [yy]yy/mm[/dd] [hh:mi:ss]
- [yy]yy/mm[/dd] [hh:mi:ss]
- [mon-][yy]yy [hh:mi:ss]
- month[,][yy]yy [hh:mi:ss]
- Returns:
- a new
IDfTime
object
-
getEnumeration
Description copied from interface:IDfClientX
Factory method for anIDfEnumeration
object. Constructs a new DFC enumeration object used to iterate a JavaEnumeration
.- Specified by:
getEnumeration
in interfaceIDfClientX
- Parameters:
en
- a JavaEnumeration
object.- Returns:
- a new
IDfEnumeration
object
-
getEnumerationFromIterator
Description copied from interface:IDfClientX
Factory method for anIDfEnumeration
object. Constructs a new DFC enumeration object used to iterate a JavaIterator
.- Specified by:
getEnumerationFromIterator
in interfaceIDfClientX
- Parameters:
it
- a JavaIterator
object.- Returns:
- a new
IDfEnumeration
object
-
getTraceLevel
public int getTraceLevel()Description copied from interface:IDfClientX
Returns the current DFC trace level. A value of zero indicates that tracing is turned off.- Specified by:
getTraceLevel
in interfaceIDfClientX
- Returns:
- the current DFC trace level.
-
setTraceLevel
public void setTraceLevel(int level) Description copied from interface:IDfClientX
Turns on DFC tracing when level is greater than 0. The default trace level is 0. A value of zero turns tracing off. The trace file should be set using thesetTraceFileName
method.- Specified by:
setTraceLevel
in interfaceIDfClientX
- Parameters:
level
- specifies the trace level.
-
getTraceFileName
Description copied from interface:IDfClientX
Returns the current DFC trace filename.- Specified by:
getTraceFileName
in interfaceIDfClientX
- Returns:
- the fully qualified file name of the current trace file.
-
setTraceFileName
Description copied from interface:IDfClientX
Redirects the trace output to the specified file. There is no default filename.- Specified by:
setTraceFileName
in interfaceIDfClientX
- Parameters:
fileName
- specifies the trace filename.
-
flushTrace
public void flushTrace()Description copied from interface:IDfClientX
Flushes the DFC trace output.- Specified by:
flushTrace
in interfaceIDfClientX
-
closeTrace
public void closeTrace()Description copied from interface:IDfClientX
Close the DFC trace output.- Specified by:
closeTrace
in interfaceIDfClientX
-
traceMsg
Description copied from interface:IDfClientX
Print a message to the DFC trace output.- Specified by:
traceMsg
in interfaceIDfClientX
- Parameters:
msg
- specifies the message to be printed.
-
traceMsgCond
Description copied from interface:IDfClientX
Conditionally print a message to the trace output. The message will print if the current trace level is less than or equal to the value of argumenttriggerLevel
.- Specified by:
traceMsgCond
in interfaceIDfClientX
- Parameters:
triggerLevel
- specifies the trace level.msg
- specifies the message to be printed.- See Also:
-
parseException
Description copied from interface:IDfClientX
Turns a string returned by OLE/COM exception into anIDfException
object.The following code example demonstrates how to obtain an
IDfException
interface from a Visual Basic generated error description:Dim clientx As New DfClientX dim e as IDfException Set e = clientx.parseException(Err.Description) If e.getErrorCode = DFCLib.IDfException_DM_DFC_E_SERVER Then ' ... ElseIf e.getErrorCode = DFCLib.IDfException_DM_DFC_E_BAD_VALUE Then ' ... End If
- Specified by:
parseException
in interfaceIDfClientX
- Parameters:
streamedExc
- OLE/COM exception message.- Returns:
- an
IDfException
interface to the exception object created from parsingstreamedExc
.
-
getQueryMgr
public com.documentum.fc.client.qb.IDfQueryMgr getQueryMgr()Description copied from interface:IDfClientX
Factory method that constructs a newIDfQueryMgr
object that is used for configuring and sending complex DQL queries to Documentum servers using the query builder objects located in thecom.documentum.fc.client.qb
package.The following code example demonstrates how to obtain an
IDfQueryMgr
interface:Dim clientx As New DfClientX dim qm as IDfQueryMgr Set qm = clientx.getQueryMgr
- Specified by:
getQueryMgr
in interfaceIDfClientX
- Returns:
- an interface to a query manager object.
-
getVirtualDocument
public IDfVirtualDocument getVirtualDocument(IDfSysObject rootObject, String lateBindingValue, boolean followRootAssembly) throws DfException Description copied from interface:IDfClientX
Returns a virtual document object where the providedIDfSysObject
is the root object of the virtual document.The following code example demonstrates how to obtain an
IDfVirtualDocument
interface:Dim clientx As New DfClientX Dim vDoc As IDfVirtualDocument Dim sysObjId As IDfId Dim sysObjRoot As IDfSysObject Set sysObjId = clientx.getId("0900d43180001104") Set sysObjRoot = sessionObj.getObject(sysObjId) Set vDoc = clientx.getVirtualDocument(sysObjRoot, "CURRENT", False)
- Specified by:
getVirtualDocument
in interfaceIDfClientX
- Parameters:
rootObject
- object of the document to serve as the root of the virtual document.lateBindingValue
- version label value to use to resolve late bound nodes of the virtual document. Pass null to use the default value "CURRENT
".followRootAssembly
-true
if the associated assembly of the root document should be followed instead of any virtual children.- Returns:
- an
IDfVirtualDocument
interface to the object. - Throws:
DfException
- if an error occurs setting up the rootObject.- See Also:
-
getOperation
Description copied from interface:IDfClientX
Factory method for creating a new operation object.The preferred approach is to use one of the
get
methods. For example,Xxxx OperationgetCopyOperation
orgetImportOperation
.For
IDfOperation
and its subclasses (for example,IDfCopyOperation
), you can create an instance by using this method. ThegetOperation
method takes one string that specifies which subclassed operation type to create.The following code example demonstrates how to obtain an
IDfOperation
interface:
Visual Basic:Dim clientx As New DfClientX Dim opObj As IDfOperation Dim opImport as IDfImportOperation Set opObj = clientx.getOperation "Import" Set opImport = opObj
Java:IDfClientX clientx = new DfClientX(); IDfImportOperation opImport = (IDfImportOperation)clientx.getOperation("Import");
- Specified by:
getOperation
in interfaceIDfClientX
- Parameters:
operationName
- specifies which subclassed operation type to create. The following are the valid strings that can be passed as operation name:Name Description Checkout Checkout operation Checkin Checkin operation Import Import operation Export Export operation CancelCheckout Cancel checkout operation Copy Copy operation Delete Delete operation Move Move operation XMLTransform XSLT transformation operation Validation XML validation operation - Returns:
- a reference to a new
IDfOperation
interface as a superclass of the specified operation object type. - Throws:
DfException
- if unable to instantiate the desired operation.- See Also:
-
IDfClientX.getImportOperation()
IDfClientX.getCheckinOperation()
IDfClientX.getExportOperation()
IDfClientX.getCheckoutOperation()
IDfClientX.getCancelCheckoutOperation()
IDfClientX.getCopyOperation()
IDfClientX.getDeleteOperation()
IDfClientX.getMoveOperation()
IDfClientX.getXMLTransformOperation()
IDfClientX.getValidationOperation()
-
getFile
Description copied from interface:IDfClientX
Factory method that constructs a newIDfFile
object that represents a file system file. DFC applications should use theIDfFile
interface rather than thejava.io.File
class when manipulating file system files.The following code example demonstrates how to obtain an
IDfFile
interface:
Java:IDfClientX clientx = new DfClientX(); IDfFile theFile = clientx.getFile( "c:/dfctest.doc" );
In Java, remember to use either a single forward slash "/" or a double backslash "\\" for the path separator. The forward slash is preferred.
Visual Basic:Dim clientx As New DfClientX Dim theFile As IDfFile Set theFile = clientx.getFile("c:\dfctest.doc")
- Specified by:
getFile
in interfaceIDfClientX
- Parameters:
filePath
- full path to the file.- Returns:
- an
IDfFile
interface to the file. - Throws:
DfException
- if the file path is equal tonull
.
-
getFormatRecognizer
public IDfFormatRecognizer getFormatRecognizer(IDfSession session, String filePath, String suggestedFormat) throws DfException Description copied from interface:IDfClientX
Factory method that constructs a newIDfFormatRecognizer
object that is used to suggest what Docbase formats might be appropriate for the specified file. TheIDfFormatRecognizer
can be used to obtain a list of all possible format choices for a given file on disk (from most likely, to least likely).The following code example demonstrates how to obtain an
IDfFormatRecognizer
interface, then loop through all suggested file formats for a given file:
Visual Basic:Dim clientx As New DfClientX Dim formatRec As IDfFormatRecognizer Dim formatList As IDfList Set theFile = clientx.getFormatRecognizer(sess, "c:/dfctest.txt", "crtext") Set formatList = formatRec.getSuggestedFileFormats For i = 0 To (formatList.getCount - 1) Debug.Print formatList.getString(i) Next i
- Specified by:
getFormatRecognizer
in interfaceIDfClientX
- Parameters:
session
- an interface to a Documentum server session.filePath
- the full path to a file on disk.suggestedFormat
- the users suggested format for the given file; typically the existing object format. This parameter can be null.- Returns:
- an
IDfFormatRecognizer
an interface to a files likely formats. - Throws:
DfException
- if the file path is equal to null.
-
getMacFormatRecognizer
public IDfFormatRecognizer getMacFormatRecognizer(IDfSession session, String dataForkPath, String resForkPath, String suggestedFormat) throws DfException Description copied from interface:IDfClientX
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.- Specified by:
getMacFormatRecognizer
in interfaceIDfClientX
- Parameters:
session
- an interface to a Documentum server session.dataForkPath
- the full path to a data fork fileresForkPath
- the full path to a resource fork filesuggestedFormat
- the users suggested format for the given file; typically the existing object format. This parameter can be null.- Returns:
- an
IDfFormatRecognizer
an interface to the file's likely formats. - Throws:
DfException
-
getClientRegistry
Description copied from interface:IDfClientX
Factory method that constructs a newIDfClientRegistry
object that provides access to the Docbase object information stored on the local system. DFC applications use theIDfClientRegistry
interface when they need to store information in the client registry for such actions as checking out an object, viewing and object, or for obtaining client configuration details.The following code examples demonstrate how to obtain an
IDfClientRegistry
interface:
Java:IDfClientX clientx = new DfClientX(); IDfClientRegistry clientReg = clientx.getClientRegistry(); if( clientReg.getExportDirectory().equalsIgnoreCase( "f:\\Documentum\\Export" ) ) { // do something here... }
Visual Basic:Dim clientx As New DfClientX Dim clientReg As IDfClientRegistry Set clientReg = clientx.getClientRegistry If clientReg.getExportDirectory = "f:\Documentum\Export" Then ' do something here... End IF
- Specified by:
getClientRegistry
in interfaceIDfClientX
- Returns:
- an
IDfClientRegistry
interface to the client registry. - Throws:
DfException
- if unable to access the client registry.
-
getDFCVersion
Description copied from interface:IDfClientX
Returns the current DFC version string.- Specified by:
getDFCVersion
in interfaceIDfClientX
- Returns:
- a String containing the DFC version string, such as
"4.2.13.283"
if successful, otherwise,"Unknown"
.
-
getLocalClient32
Description copied from interface:IDfClientX
Returns a DFC local client object that will call into DMCL32.dll for backward compatibility with pre-4.0 Documentum servers.This method call will precede the calls to connect to the Documentum server (
IDfClient.newSession(), IDfClient.getSharedSession()
).The following code example demonstrates how to obtain an
IDfClient
interface:Dim clientx As New DfClientX Dim client As IDfClient Dim sess As IDfSession Set client = clientx.getLocalClient32 ' Login details are then setup here... ' Then a session is established with the Documentum server... Set sess = client.newSession("docbaseName", loginInfoObj)
- Specified by:
getLocalClient32
in interfaceIDfClientX
- Throws:
DfException
- if we cannot load or initialize DMCL.
-
setTraceTime
public void setTraceTime(boolean fEnable) Description copied from interface:IDfClientX
Set the DFC trace to contain timing information.- Specified by:
setTraceTime
in interfaceIDfClientX
-
getTraceTime
public boolean getTraceTime()Description copied from interface:IDfClientX
Returns if the current DFC trace contains timing information.- Specified by:
getTraceTime
in interfaceIDfClientX
- Returns:
- true if the DFC trace includes timing information,
false
if it does not.
-
setTraceThreads
public void setTraceThreads(boolean fEnable) Description copied from interface:IDfClientX
Sets the DFC trace to contain threading information.- Specified by:
setTraceThreads
in interfaceIDfClientX
- Parameters:
fEnable
-true
to enable the threading information in the trace.
-
getTraceThreads
public boolean getTraceThreads()Description copied from interface:IDfClientX
Returns if the current DFC trace contains threading information.- Specified by:
getTraceThreads
in interfaceIDfClientX
- Returns:
true
if threading information is included in the trace orfalse
if not.
-
getVirtualDocumentNodeFromToken
public IDfVirtualDocumentNode getVirtualDocumentNodeFromToken(IDfSession session, String token) throws DfException Description copied from interface:IDfClientX
Returns an interface to a node of a virtual document given a unique token that represents the node in the virtual document tree. Each node in a virtual document tree can have a unique token. The token corresponds to document node in a particular format (the format corresponds to the virtual document node's position with respect to the root).For example,
Root | |-- Child1 | | | --- Child1_1 | --- Child1_2 | --- Child2
Assume Root has a chronicle id as0900123480002345
, Child1 has chronicle id as0900123480003456
, and the late binding for the virtual document Root node is specified as"CURRENT"
. Thetoken
for Child1 would be"0900123480002345_3456|CURRENT"
.Assume Child1_1 has a chronicle id as
0900123480003457
, then thetoken
for Child1_1 would be "0900123480002345_3456_7|CURRENT
".If the Root node is following assembly, then the
token
for Child1 would be "0900123480002345_3456|FA
", and thetoken
for Child1_1 would be "0900123480002345_3456_7|FA
".The following code example demonstrates how to obtain an
IDfVirtualDocumentNode
interface where late binding is specified as"CURRENT"
, and the desired node is the first child in a virtual document tree:Dim clientx As New DfClientX Dim vDocNode As IDfVirtualDocumentNode Set vDocNode = clientx.getVirtualDocumentNodeFromToken( sess, "0900123480002345_3456|CURRENT")
- Specified by:
getVirtualDocumentNodeFromToken
in interfaceIDfClientX
- Parameters:
session
- an interface to a DFC session.token
- a string representing a node in a virtual document tree.- Returns:
- an
IDfVirtualDocumentNode
interface to the desired node. - Throws:
DfException
- if the node is not available (token
is malformed).
-
ByteArrayInputStreamToString
Description copied from interface:IDfClientX
Converts a JavaByteArrayInputStream
object into a String. Used to convert the results ofIDfSysObject.getContent()
into a string.- Specified by:
ByteArrayInputStreamToString
in interfaceIDfClientX
- Parameters:
bais
- a JavaByteArrayInputStream
object.- Returns:
- a
String
extracted from the JavaByteArrayInputStream
object
-
StringToByteArrayOutputStream
Description copied from interface:IDfClientX
Converts a String into a JavaByteArrayOutputStream
object. Used to callIDfSysObject.setContent(java.io.ByteArrayOutputStream)
.- Specified by:
StringToByteArrayOutputStream
in interfaceIDfClientX
- Parameters:
s
- the string to convert into a JavaByteArrayOutputStream
object.- Returns:
- a Java
ByteArrayOutputStream
object
-
getXMLUtils
Description copied from interface:IDfClientX
Factory method that constructs a newIDfXMLUtils
object that provides methods for XML related functions, likegetApplicationByDTD, getObjectIdFromDRL , isXML, isHTML,
and so on.- Specified by:
getXMLUtils
in interfaceIDfClientX
- Returns:
- an
IDfXMLUtils
interface
-
getImportOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfImportOperation
object for importing one or more files into the repository.- Specified by:
getImportOperation
in interfaceIDfClientX
- Returns:
- A new
IDfImportOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getCheckinOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfCheckinOperation
object for checking in one or more checked out repository objects.- Specified by:
getCheckinOperation
in interfaceIDfClientX
- Returns:
- a new
IDfCheckinOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getExportOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfExportOperation
object for exporting one or more repository objects to the file system.- Specified by:
getExportOperation
in interfaceIDfClientX
- Returns:
- a new
IDfExportOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getPredictiveCachingOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfPredictiveCachingOperation
object for predictive content caching.- Specified by:
getPredictiveCachingOperation
in interfaceIDfClientX
- Returns:
- a new
IDfPredictiveCachingOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getCheckoutOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfCheckoutOperation
object for checking in one or more repository objects previously checked out.- Specified by:
getCheckoutOperation
in interfaceIDfClientX
- Returns:
- a new
IDfCheckoutOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getCancelCheckoutOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfCancelCheckout
object.- Specified by:
getCancelCheckoutOperation
in interfaceIDfClientX
- Returns:
- a new
IDfCancelCheckout
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getCopyOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfCopyOperation
object.- Specified by:
getCopyOperation
in interfaceIDfClientX
- Returns:
- a new
IDfCopyOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getDeleteOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfDeleteOperation
object.- Specified by:
getDeleteOperation
in interfaceIDfClientX
- Returns:
- a new
IDfDeleteOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getMoveOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfMoveOperation
object.- Specified by:
getMoveOperation
in interfaceIDfClientX
- Returns:
- a new
IDfMoveOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getXMLTransformOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfTransformOperation
object for using XSLT to transform one or more XML documents into another form, such as HTML, PDF, etc.- Specified by:
getXMLTransformOperation
in interfaceIDfClientX
- Returns:
- a new
IDfXMLTransformOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getValidationOperation
Description copied from interface:IDfClientX
Factory method that constructs a newIDfValidationOperation
object.- Specified by:
getValidationOperation
in interfaceIDfClientX
- Returns:
- a new
IDfValidationOperation
object. - Throws:
DfException
- if unable to instantiate the desired operation- See Also:
-
getContentPackageFactory
public com.documentum.operations.contentpackage.IDfContentPackageFactory getContentPackageFactory()Description copied from interface:IDfClientX
Factory method that returns a handle toIDfContentPackageFactory
object.- Specified by:
getContentPackageFactory
in interfaceIDfClientX
-
getTracer
public com.documentum.djcb.IDfTracer getTracer()- Specified by:
getTracer
in interfaceIDfClientX
-
getLogger
public com.documentum.djcb.IDfLogger getLogger()- Specified by:
getLogger
in interfaceIDfClientX
-
getXMLDocType
Description copied from interface:IDfClientX
Factory method that contructs a newIDfXMLDocType
object.- Specified by:
getXMLDocType
in interfaceIDfClientX
- Returns:
- a new
IDfXMLDocType
object. - See Also:
-
getPermit
Description copied from interface:IDfClientX
Factory method that contructs a newIDfPermit
object.- Specified by:
getPermit
in interfaceIDfClientX
- Returns:
- a new
IDfPermit
object. - See Also:
-
getDocbrokerClient
Description copied from interface:IDfClientX
Factory method that contructs a newIDfDocbrokerClient
instance.- Specified by:
getDocbrokerClient
in interfaceIDfClientX
- Throws:
DfException
- See Also:
-
getAcsTransferPreferences
Description copied from interface:IDfClientX
Factory method that constructs a newIDfAcsTransferPreferences
instance.- Specified by:
getAcsTransferPreferences
in interfaceIDfClientX
- Returns:
- IDfAcsTransferPreferences object
-
getAcsClient
Description copied from interface:IDfClientX
Returns anIDfAcsClient
object.- Specified by:
getAcsClient
in interfaceIDfClientX
- Returns:
IDfAcsClient
object
-
getXQueryTargets
public com.documentum.xml.xquery.IDfXQueryTargets getXQueryTargets(int targetCategory) throws DfException Description copied from interface:IDfClientX
Factory method that constructs a newIDfXQueryTargets
object.- Specified by:
getXQueryTargets
in interfaceIDfClientX
- Parameters:
targetCategory
- - must be either IDfXQueryTargets.DF_XMLSTORE or IDfXQueryTargets.DF_FULLTEXT- Returns:
- a new
IDfXQueryTargets
object - Throws:
DfException
-