public class DfClientX extends com.documentum.fc.common.DfObject implements IDfClientX, java.io.Serializable
Constructor and Description |
---|
DfClientX() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
ByteArrayInputStreamToString(java.io.ByteArrayInputStream bais)
Converts a Java
ByteArrayInputStream object into a String. |
void |
closeTrace()
Close the DFC trace output.
|
java.lang.Object |
deserializeObject(java.lang.String image)
Restores the object from its serialized image.
|
void |
flushTrace()
Flushes the DFC trace output.
|
IDfAcsClient |
getAcsClient()
Returns an
IDfAcsClient object. |
IDfAcsTransferPreferences |
getAcsTransferPreferences()
Factory method that constructs a new
IDfAcsTransferPreferences instance. |
IDfCancelCheckoutOperation |
getCancelCheckoutOperation()
Factory method that constructs a new
IDfCancelCheckout object. |
IDfCheckinOperation |
getCheckinOperation()
Factory method that constructs a new
IDfCheckinOperation object for checking in one or more checked
out repository objects. |
IDfCheckoutOperation |
getCheckoutOperation()
Factory method that constructs a new
IDfCheckoutOperation object for checking in one or more
repository objects previously checked out. |
IDfClientRegistry |
getClientRegistry()
Factory method that constructs a new
IDfClientRegistry
object that provides access to the Docbase object information stored on
the local system. |
com.documentum.operations.contentpackage.IDfContentPackageFactory |
getContentPackageFactory()
Factory method that returns a handle to
IDfContentPackageFactory object. |
IDfCopyOperation |
getCopyOperation()
Factory method that constructs a new
IDfCopyOperation object. |
IDfDborEntry |
getDborEntry()
Factory method that constructs a new
IDfDborEntry object. |
IDfDeleteOperation |
getDeleteOperation()
Factory method that constructs a new
IDfDeleteOperation object. |
java.lang.String |
getDFCVersion()
Returns the current DFC version string.
|
IDfDocbrokerClient |
getDocbrokerClient()
Factory method that contructs a new
IDfDocbrokerClient instance. |
IDfEnumeration |
getEnumeration(java.util.Enumeration en)
Factory method for an
IDfEnumeration object. |
IDfEnumeration |
getEnumerationFromIterator(java.util.Iterator it)
Factory method for an
IDfEnumeration object. |
IDfExportOperation |
getExportOperation()
Factory method that constructs a new
IDfExportOperation object for exporting one or more repository
objects to the file system. |
IDfFile |
getFile(java.lang.String filePath)
Factory method that constructs a new
IDfFile object that
represents a file system file. |
IDfFormatRecognizer |
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. |
IDfGetObjectOptions |
getGetObjectOptions()
Factory method for an
IDfGetObjectOptions object. |
IDfId |
getId(java.lang.String id)
Factory method for an
IDfId object. |
IDfImportOperation |
getImportOperation()
Factory method that constructs a new
IDfImportOperation object for importing one or more files into
the repository. |
IDfList |
getList()
Factory method for an
IDfList object. |
IDfClient |
getLocalClient()
Factory method for an
IDfClient object. |
IDfClient |
getLocalClient32()
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 |
getLogger() |
IDfLoginInfo |
getLoginInfo()
Factory method for an
IDfLoginInfo object. |
IDfFormatRecognizer |
getMacFormatRecognizer(IDfSession session,
java.lang.String dataForkPath,
java.lang.String resForkPath,
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. |
IDfMoveOperation |
getMoveOperation()
Factory method that constructs a new
IDfMoveOperation object. |
IDfOperation |
getOperation(java.lang.String operationName)
Factory method for creating a new operation object.
|
IDfPermit |
getPermit()
Factory method that contructs a new
IDfPermit object. |
IDfPredictiveCachingOperation |
getPredictiveCachingOperation()
Factory method that constructs a new
IDfPredictiveCachingOperation object
for predictive content caching. |
IDfProperties |
getProperties()
Factory method that constructs a new empty
IDfProperties object that provides functionality for
manipulating values in a hashable. |
IDfQuery |
getQuery()
Factory method for an
IDfQuery object. |
com.documentum.fc.client.qb.IDfQueryMgr |
getQueryMgr()
Factory method that constructs a new
IDfQueryMgr object that is used for configuring and sending complex DQL queries to
Documentum servers using the query builder objects located in the
com.documentum.fc.client.qb package. |
IDfTime |
getTime(java.lang.String time,
java.lang.String pattern)
Factory method for an
IDfTime object. |
java.lang.String |
getTraceFileName()
Returns the current DFC trace filename.
|
int |
getTraceLevel()
Returns the current DFC trace level.
|
com.documentum.djcb.IDfTracer |
getTracer() |
boolean |
getTraceThreads()
Returns if the current DFC trace contains threading information.
|
boolean |
getTraceTime()
Returns if the current DFC trace contains timing information.
|
IDfValidationOperation |
getValidationOperation()
Factory method that constructs a new
IDfValidationOperation object. |
IDfVirtualDocument |
getVirtualDocument(IDfSysObject rootObject,
java.lang.String lateBindingValue,
boolean followRootAssembly)
Returns a virtual document object where the provided
IDfSysObject is the
root object of the virtual document. |
IDfVirtualDocumentNode |
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.
|
IDfXMLDocType |
getXMLDocType()
Factory method that contructs a new
IDfXMLDocType object. |
IDfXmlQuery |
getXmlQuery()
Factory method that constructs a new
IDfXmlQuery object. |
IDfXMLTransformOperation |
getXMLTransformOperation()
Factory method that constructs a new
IDfTransformOperation object for using XSLT to transform one or
more XML documents into another form, such as HTML, PDF, etc. |
IDfXMLUtils |
getXMLUtils()
Factory method that constructs a new
IDfXMLUtils object that provides methods for XML related
functions, like getApplicationByDTD, getObjectIdFromDRL , isXML, isHTML, and so on. |
IDfXQuery |
getXQuery()
Factory method that constructs a new
IDfXQuery object. |
com.documentum.xml.xquery.IDfXQueryTargets |
getXQueryTargets(int targetCategory)
Factory method that constructs a new
IDfXQueryTargets object. |
IDfException |
parseException(java.lang.String streamedExc)
Turns a string returned by OLE/COM exception into an
IDfException object. |
java.lang.String |
serializeObject(java.lang.Object object)
Serializes an object.
|
void |
setTraceFileName(java.lang.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.
|
java.io.ByteArrayOutputStream |
StringToByteArrayOutputStream(java.lang.String s)
Converts a String into a Java
ByteArrayOutputStream object. |
void |
traceMsg(java.lang.String msg)
Print a message to the DFC trace output.
|
void |
traceMsgCond(int triggerLevel,
java.lang.String msg)
Conditionally print a message to the trace output.
|
public IDfClient getLocalClient() throws DfException
IDfClientX
IDfClient
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 same IDfClient
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:
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 );
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 )
getLocalClient
in interface IDfClientX
DfException
- an error object with an error code
DM_DFC_E_INIT_DMCL
indicating DMCL40.dll could not be
loaded.IDfClientX.getLocalClient32()
public IDfLoginInfo getLoginInfo()
IDfClientX
IDfLoginInfo
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:
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" )
getLoginInfo
in interface IDfClientX
IDfLoginInfo
interface to a new empty DfLoginInfo
objectIDfClient.newSessionManager()
,
IDfSessionManager.setIdentity(java.lang.String, com.documentum.fc.common.IDfLoginInfo)
,
IDfClient.newSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo)
,
IDfClient.getSharedSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo, java.lang.String)
public IDfQuery getQuery()
IDfClientX
IDfQuery
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:
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)
getQuery
in interface IDfClientX
IDfQuery
interface to a query object.public IDfGetObjectOptions getGetObjectOptions()
IDfClientX
IDfGetObjectOptions
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.
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... }
getGetObjectOptions
in interface IDfClientX
IDfGetObjectOptions
interface to a new empty object options.public IDfXmlQuery getXmlQuery()
IDfClientX
IDfXmlQuery
object.getXmlQuery
in interface IDfClientX
IDfXmlQuery
object.IDfXmlQuery
public IDfXQuery getXQuery()
IDfClientX
IDfXQuery
object.getXQuery
in interface IDfClientX
IDfXQuery
object.IDfXQuery
public IDfDborEntry getDborEntry()
IDfClientX
IDfDborEntry
object.getDborEntry
in interface IDfClientX
IDfDborEntry
object.IDfDborEntry
public java.lang.String serializeObject(java.lang.Object object)
IDfClientX
serializeObject
in interface IDfClientX
object
- object to serializepublic java.lang.Object deserializeObject(java.lang.String image) throws DfException
IDfClientX
deserializeObject
in interface IDfClientX
image
- serialized objectDfException
public IDfList getList()
IDfClientX
IDfList
object. Constructs a new
IDfList
object representing an empty list to fill with data.
DFC applications should always use an IDfList
object instead
of a java.util.List
object.
The following code example demonstrates how to obtain an
IDfList
interface and insert
a value into the list:
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... }
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
getList
in interface IDfClientX
IDfList
interface to a new list object.IDfList.getList(int)
,
IDfProperties.getList(java.lang.String)
public IDfProperties getProperties()
IDfClientX
IDfProperties
object that provides functionality for
manipulating values in a hashable. DFC applications should always use an IDfProperties
object
instead of a java.util.Hashtable
object.getProperties
in interface IDfClientX
IDfProperties
interfacepublic IDfId getId(java.lang.String id)
IDfClientX
IDfId
object. Constructs a new
IDfId
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
getId
in interface IDfClientX
id
- the object id of an object in the Documentum server.IDfId
an interface to an object id.IDfId.getId()
,
IDfTypedObject.getId(java.lang.String)
,
IDfTypedObject.getId(java.lang.String)
,
IDfVirtualDocument.getId()
public IDfTime getTime(java.lang.String time, java.lang.String pattern)
IDfClientX
IDfTime
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")
getTime
in interface IDfClientX
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]
IDfTime
objectpublic IDfEnumeration getEnumeration(java.util.Enumeration en)
IDfClientX
IDfEnumeration
object. Constructs a new DFC enumeration object used to
iterate a Java Enumeration
.getEnumeration
in interface IDfClientX
en
- a Java Enumeration
object.IDfEnumeration
objectpublic IDfEnumeration getEnumerationFromIterator(java.util.Iterator it)
IDfClientX
IDfEnumeration
object. Constructs a new DFC enumeration object used to
iterate a Java Iterator
.getEnumerationFromIterator
in interface IDfClientX
it
- a Java Iterator
object.IDfEnumeration
objectpublic int getTraceLevel()
IDfClientX
getTraceLevel
in interface IDfClientX
public void setTraceLevel(int level)
IDfClientX
setTraceFileName
method.setTraceLevel
in interface IDfClientX
level
- specifies the trace level.public java.lang.String getTraceFileName()
IDfClientX
getTraceFileName
in interface IDfClientX
public void setTraceFileName(java.lang.String fileName)
IDfClientX
setTraceFileName
in interface IDfClientX
fileName
- specifies the trace filename.public void flushTrace()
IDfClientX
flushTrace
in interface IDfClientX
public void closeTrace()
IDfClientX
closeTrace
in interface IDfClientX
public void traceMsg(java.lang.String msg)
IDfClientX
traceMsg
in interface IDfClientX
msg
- specifies the message to be printed.public void traceMsgCond(int triggerLevel, java.lang.String msg)
IDfClientX
triggerLevel
.traceMsgCond
in interface IDfClientX
triggerLevel
- specifies the trace level.msg
- specifies the message to be printed.IDfClientX.traceMsgCond(int, java.lang.String)
public IDfException parseException(java.lang.String streamedExc)
IDfClientX
IDfException
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
parseException
in interface IDfClientX
streamedExc
- OLE/COM exception message.IDfException
interface to the exception object created from
parsing streamedExc
.public com.documentum.fc.client.qb.IDfQueryMgr getQueryMgr()
IDfClientX
IDfQueryMgr
object that is used for configuring and sending complex DQL queries to
Documentum servers using the query builder objects located in the
com.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
getQueryMgr
in interface IDfClientX
public IDfVirtualDocument getVirtualDocument(IDfSysObject rootObject, java.lang.String lateBindingValue, boolean followRootAssembly) throws DfException
IDfClientX
IDfSysObject
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)
getVirtualDocument
in interface IDfClientX
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.IDfVirtualDocument
interface to the object.DfException
- if an error occurs setting up the rootObject.IDfSysObject.asVirtualDocument(java.lang.String, boolean)
public IDfOperation getOperation(java.lang.String operationName) throws DfException
IDfClientX
The preferred approach is to use one of the get
methods. For example, getCopyOperation
or
getImportOperation
.
For IDfOperation
and its subclasses (for example,
IDfCopyOperation
), you can create an instance by using this
method. The getOperation
method takes one string that
specifies which subclassed operation type to create.
The following code example demonstrates how to obtain an
IDfOperation
interface:
Dim clientx As New DfClientX Dim opObj As IDfOperation Dim opImport as IDfImportOperation Set opObj = clientx.getOperation "Import" Set opImport = opObj
IDfClientX clientx = new DfClientX(); IDfImportOperation opImport = (IDfImportOperation)clientx.getOperation("Import");
getOperation
in interface IDfClientX
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 |
IDfOperation
interface as a
superclass of the specified operation object type.DfException
- if unable to instantiate the desired operation.IDfClientX.getImportOperation()
,
IDfClientX.getCheckinOperation()
,
IDfClientX.getExportOperation()
,
IDfClientX.getCheckoutOperation()
,
IDfClientX.getCancelCheckoutOperation()
,
IDfClientX.getCopyOperation()
,
IDfClientX.getDeleteOperation()
,
IDfClientX.getMoveOperation()
,
IDfClientX.getXMLTransformOperation()
,
IDfClientX.getValidationOperation()
public IDfFile getFile(java.lang.String filePath) throws DfException
IDfClientX
IDfFile
object that
represents a file system file. DFC applications should use the
IDfFile
interface rather than the java.io.File
class when manipulating file system files.
The following code example demonstrates how to obtain an
IDfFile
interface:
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.
Dim clientx As New DfClientX Dim theFile As IDfFile Set theFile = clientx.getFile("c:\dfctest.doc")
getFile
in interface IDfClientX
filePath
- full path to the file.IDfFile
interface to the file.DfException
- if the file path is equal to null
.public IDfFormatRecognizer getFormatRecognizer(IDfSession session, java.lang.String filePath, java.lang.String suggestedFormat) throws DfException
IDfClientX
IDfFormatRecognizer
object that is used to suggest what Docbase formats might be appropriate
for the specified file. The IDfFormatRecognizer
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:
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
getFormatRecognizer
in interface IDfClientX
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.IDfFormatRecognizer
an interface to a files likely formats.DfException
- if the file path is equal to null.public IDfFormatRecognizer getMacFormatRecognizer(IDfSession session, java.lang.String dataForkPath, java.lang.String resForkPath, java.lang.String suggestedFormat) throws DfException
IDfClientX
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.getMacFormatRecognizer
in interface IDfClientX
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.IDfFormatRecognizer
an interface to the file's likely formats.DfException
public IDfClientRegistry getClientRegistry() throws DfException
IDfClientX
IDfClientRegistry
object that provides access to the Docbase object information stored on
the local system. DFC applications use the IDfClientRegistry
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:
IDfClientX clientx = new DfClientX(); IDfClientRegistry clientReg = clientx.getClientRegistry(); if( clientReg.getExportDirectory().equalsIgnoreCase( "f:\\Documentum\\Export" ) ) { // do something here... }
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
getClientRegistry
in interface IDfClientX
IDfClientRegistry
interface to the client registry.DfException
- if unable to access the client registry.public java.lang.String getDFCVersion()
IDfClientX
getDFCVersion
in interface IDfClientX
"4.2.13.283"
if successful, otherwise,
"Unknown"
.public IDfClient getLocalClient32() throws DfException
IDfClientX
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)
getLocalClient32
in interface IDfClientX
DfException
- if we cannot load or initialize DMCL.public void setTraceTime(boolean fEnable)
IDfClientX
setTraceTime
in interface IDfClientX
public boolean getTraceTime()
IDfClientX
getTraceTime
in interface IDfClientX
false
if it does not.public void setTraceThreads(boolean fEnable)
IDfClientX
setTraceThreads
in interface IDfClientX
fEnable
- true
to enable the threading information in the trace.public boolean getTraceThreads()
IDfClientX
getTraceThreads
in interface IDfClientX
true
if threading information is included in the trace or false
if not.public IDfVirtualDocumentNode getVirtualDocumentNodeFromToken(IDfSession session, java.lang.String token) throws DfException
IDfClientX
For example,
Root | |-- Child1 | | | --- Child1_1 | --- Child1_2 | --- Child2Assume Root has a chronicle id as
0900123480002345
, Child1
has chronicle id as 0900123480003456
, and the late binding
for the virtual document Root node is specified as
"CURRENT"
. The token
for Child1 would be
"0900123480002345_3456|CURRENT"
.
Assume Child1_1 has a chronicle id as 0900123480003457
, then
the token
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 the
token
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")
getVirtualDocumentNodeFromToken
in interface IDfClientX
session
- an interface to a DFC session.token
- a string representing a node in a virtual document tree.IDfVirtualDocumentNode
interface to the desired
node.DfException
- if the node is not available (token
is malformed).public java.lang.String ByteArrayInputStreamToString(java.io.ByteArrayInputStream bais)
IDfClientX
ByteArrayInputStream
object into a String. Used to convert the results of IDfSysObject.getContent()
into a string.ByteArrayInputStreamToString
in interface IDfClientX
bais
- a Java ByteArrayInputStream
object.String
extracted from the Java ByteArrayInputStream
objectpublic java.io.ByteArrayOutputStream StringToByteArrayOutputStream(java.lang.String s)
IDfClientX
ByteArrayOutputStream
object. Used to call IDfSysObject.setContent(java.io.ByteArrayOutputStream)
.StringToByteArrayOutputStream
in interface IDfClientX
s
- the string to convert into a Java ByteArrayOutputStream
object.ByteArrayOutputStream
objectpublic IDfXMLUtils getXMLUtils()
IDfClientX
IDfXMLUtils
object that provides methods for XML related
functions, like getApplicationByDTD, getObjectIdFromDRL , isXML, isHTML,
and so on.getXMLUtils
in interface IDfClientX
IDfXMLUtils
interfacepublic IDfImportOperation getImportOperation() throws DfException
IDfClientX
IDfImportOperation
object for importing one or more files into
the repository. getImportOperation
in interface IDfClientX
IDfImportOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfImportOperation
,
IDfImportNode
public IDfCheckinOperation getCheckinOperation() throws DfException
IDfClientX
IDfCheckinOperation
object for checking in one or more checked
out repository objects.getCheckinOperation
in interface IDfClientX
IDfCheckinOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfCheckinOperation
,
IDfCheckinNode
public IDfExportOperation getExportOperation() throws DfException
IDfClientX
IDfExportOperation
object for exporting one or more repository
objects to the file system.getExportOperation
in interface IDfClientX
IDfExportOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfExportOperation
,
IDfExportNode
public IDfPredictiveCachingOperation getPredictiveCachingOperation() throws DfException
IDfClientX
IDfPredictiveCachingOperation
object
for predictive content caching.getPredictiveCachingOperation
in interface IDfClientX
IDfPredictiveCachingOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfPredictiveCachingOperation
,
IDfPredictiveCachingNode
public IDfCheckoutOperation getCheckoutOperation() throws DfException
IDfClientX
IDfCheckoutOperation
object for checking in one or more
repository objects previously checked out.getCheckoutOperation
in interface IDfClientX
IDfCheckoutOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfCheckoutOperation
,
IDfCheckoutNode
public IDfCancelCheckoutOperation getCancelCheckoutOperation() throws DfException
IDfClientX
IDfCancelCheckout
object.getCancelCheckoutOperation
in interface IDfClientX
IDfCancelCheckout
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfCancelCheckoutOperation
,
IDfCancelCheckoutNode
public IDfCopyOperation getCopyOperation() throws DfException
IDfClientX
IDfCopyOperation
object.getCopyOperation
in interface IDfClientX
IDfCopyOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfCopyOperation
,
IDfCopyNode
public IDfDeleteOperation getDeleteOperation() throws DfException
IDfClientX
IDfDeleteOperation
object.getDeleteOperation
in interface IDfClientX
IDfDeleteOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfDeleteOperation
,
IDfDeleteNode
public IDfMoveOperation getMoveOperation() throws DfException
IDfClientX
IDfMoveOperation
object.getMoveOperation
in interface IDfClientX
IDfMoveOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfMoveOperation
,
IDfMoveNode
public IDfXMLTransformOperation getXMLTransformOperation() throws DfException
IDfClientX
IDfTransformOperation
object for using XSLT to transform one or
more XML documents into another form, such as HTML, PDF, etc.getXMLTransformOperation
in interface IDfClientX
IDfXMLTransformOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfXMLTransformOperation
,
IDfXMLTransformNode
public IDfValidationOperation getValidationOperation() throws DfException
IDfClientX
IDfValidationOperation
object.getValidationOperation
in interface IDfClientX
IDfValidationOperation
object.DfException
- if unable to instantiate the desired operationIDfOperation
,
IDfValidationOperation
,
IDfValidationNode
public com.documentum.operations.contentpackage.IDfContentPackageFactory getContentPackageFactory()
IDfClientX
IDfContentPackageFactory
object.getContentPackageFactory
in interface IDfClientX
public com.documentum.djcb.IDfTracer getTracer()
getTracer
in interface IDfClientX
public com.documentum.djcb.IDfLogger getLogger()
getLogger
in interface IDfClientX
public IDfXMLDocType getXMLDocType()
IDfClientX
IDfXMLDocType
object.getXMLDocType
in interface IDfClientX
IDfXMLDocType
object.IDfXMLDocType
public IDfPermit getPermit()
IDfClientX
IDfPermit
object.getPermit
in interface IDfClientX
IDfPermit
object.IDfPermit
public IDfDocbrokerClient getDocbrokerClient() throws DfException
IDfClientX
IDfDocbrokerClient
instance.getDocbrokerClient
in interface IDfClientX
DfException
IDfDocbrokerClient
public IDfAcsTransferPreferences getAcsTransferPreferences()
IDfClientX
IDfAcsTransferPreferences
instance.getAcsTransferPreferences
in interface IDfClientX
public IDfAcsClient getAcsClient()
IDfClientX
IDfAcsClient
object.getAcsClient
in interface IDfClientX
IDfAcsClient
objectpublic com.documentum.xml.xquery.IDfXQueryTargets getXQueryTargets(int targetCategory) throws DfException
IDfClientX
IDfXQueryTargets
object.getXQueryTargets
in interface IDfClientX
targetCategory
- - must be either IDfXQueryTargets.DF_XMLSTORE or
IDfXQueryTargets.DF_FULLTEXTIDfXQueryTargets
objectDfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.