Package com.documentum.com

Class DfClientX

java.lang.Object
com.documentum.fc.common.DfObject
com.documentum.com.DfClientX
All Implemented Interfaces:
IDfClientX, Serializable
public class DfClientX extends com.documentum.fc.common.DfObject implements IDfClientX, Serializable
See Also:

  • Constructor Details

    • DfClientX

      public DfClientX()

  • Method Details

    • getLocalClient

      public IDfClient getLocalClient() throws DfException
      Description copied from interface: IDfClientX
      Factory method for an 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:

      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 interface IDfClientX
      Returns:
      a DFC local client object.
      Throws:
      DfException - an error object with an error code DM_DFC_E_INIT_DMCL indicating DMCL40.dll could not be loaded.
      See Also:

    • getLoginInfo

      public IDfLoginInfo getLoginInfo()
      Description copied from interface: IDfClientX
      Factory method for an 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:

      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 interface IDfClientX
      Returns:
      an IDfLoginInfo interface to a new empty DfLoginInfo object
      See Also:

    • getQuery

      public IDfQuery getQuery()
      Description copied from interface: IDfClientX
      Factory method for an 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:

      Java:
       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 );
      Visual Basic:

       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 interface IDfClientX
      Returns:
      an IDfQuery interface to a query object.

    • getGetObjectOptions

      public IDfGetObjectOptions getGetObjectOptions()
      Description copied from interface: IDfClientX
      Factory method for an 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.

      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 interface IDfClientX
      Returns:
      an IDfGetObjectOptions interface to a new empty object options.

    • getXmlQuery

      public IDfXmlQuery getXmlQuery()
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfXmlQuery object.
      Specified by:
      getXmlQuery in interface IDfClientX
      Returns:
      a new IDfXmlQuery object.
      See Also:

    • getXQuery

      public IDfXQuery getXQuery()
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfXQuery object.
      Specified by:
      getXQuery in interface IDfClientX
      Returns:
      a new IDfXQuery object.
      See Also:

    • getDborEntry

      public IDfDborEntry getDborEntry()
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfDborEntry object.
      Specified by:
      getDborEntry in interface IDfClientX
      Returns:
      a new IDfDborEntry object.
      See Also:

    • serializeObject

      public String serializeObject(Object object)
      Description copied from interface: IDfClientX
      Serializes an object. It is used for passing the object across process boundaries.
      Specified by:
      serializeObject in interface IDfClientX
      Parameters:
      object - object to serialize
      Returns:
      the serialized object

    • deserializeObject

      public Object deserializeObject(String image) throws DfException
      Description copied from interface: IDfClientX
      Restores the object from its serialized image.
      Specified by:
      deserializeObject in interface IDfClientX
      Parameters:
      image - serialized object
      Returns:
      the deserialized object
      Throws:
      DfException

    • getList

      public IDfList getList()
      Description copied from interface: IDfClientX
      Factory method for an 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:

      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 interface IDfClientX
      Returns:
      an IDfList interface to a new list object.
      See Also:

    • getProperties

      public IDfProperties getProperties()
      Description copied from interface: IDfClientX
      Factory method that constructs a new empty 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.
      Specified by:
      getProperties in interface IDfClientX
      Returns:
      an IDfProperties interface

    • getId

      public IDfId getId(String id)
      Description copied from interface: IDfClientX
      Factory method for an 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
      Specified by:
      getId in interface IDfClientX
      Parameters:
      id - the object id of an object in the Documentum server.
      Returns:
      an IDfId an interface to an object id.
      See Also:

    • getTime

      public IDfTime getTime(String time, String pattern)
      Description copied from interface: IDfClientX
      Factory method for an 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")
      Specified by:
      getTime in interface IDfClientX
      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

      public IDfEnumeration getEnumeration(Enumeration en)
      Description copied from interface: IDfClientX
      Factory method for an IDfEnumeration object. Constructs a new DFC enumeration object used to iterate a Java Enumeration.
      Specified by:
      getEnumeration in interface IDfClientX
      Parameters:
      en - a Java Enumeration object.
      Returns:
      a new IDfEnumeration object

    • getEnumerationFromIterator

      public IDfEnumeration getEnumerationFromIterator(Iterator it)
      Description copied from interface: IDfClientX
      Factory method for an IDfEnumeration object. Constructs a new DFC enumeration object used to iterate a Java Iterator.
      Specified by:
      getEnumerationFromIterator in interface IDfClientX
      Parameters:
      it - a Java Iterator 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 interface IDfClientX
      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 the setTraceFileName method.

      Specified by:
      setTraceLevel in interface IDfClientX
      Parameters:
      level - specifies the trace level.

    • getTraceFileName

      public String getTraceFileName()
      Description copied from interface: IDfClientX
      Returns the current DFC trace filename.
      Specified by:
      getTraceFileName in interface IDfClientX
      Returns:
      the fully qualified file name of the current trace file.

    • setTraceFileName

      public void setTraceFileName(String fileName)
      Description copied from interface: IDfClientX
      Redirects the trace output to the specified file. There is no default filename.
      Specified by:
      setTraceFileName in interface IDfClientX
      Parameters:
      fileName - specifies the trace filename.

    • flushTrace

      public void flushTrace()
      Description copied from interface: IDfClientX
      Flushes the DFC trace output.
      Specified by:
      flushTrace in interface IDfClientX

    • closeTrace

      public void closeTrace()
      Description copied from interface: IDfClientX
      Close the DFC trace output.
      Specified by:
      closeTrace in interface IDfClientX

    • traceMsg

      public void traceMsg(String msg)
      Description copied from interface: IDfClientX
      Print a message to the DFC trace output.
      Specified by:
      traceMsg in interface IDfClientX
      Parameters:
      msg - specifies the message to be printed.

    • traceMsgCond

      public void traceMsgCond(int triggerLevel, String msg)
      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 argument triggerLevel.
      Specified by:
      traceMsgCond in interface IDfClientX
      Parameters:
      triggerLevel - specifies the trace level.
      msg - specifies the message to be printed.
      See Also:

    • parseException

      public IDfException parseException(String streamedExc)
      Description copied from interface: IDfClientX
      Turns a string returned by OLE/COM exception into an 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
      Specified by:
      parseException in interface IDfClientX
      Parameters:
      streamedExc - OLE/COM exception message.
      Returns:
      an IDfException interface to the exception object created from parsing streamedExc.

    • getQueryMgr

      public com.documentum.fc.client.qb.IDfQueryMgr getQueryMgr()
      Description copied from interface: IDfClientX
      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.

      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 interface IDfClientX
      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 provided 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)
      Specified by:
      getVirtualDocument in interface IDfClientX
      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

      public IDfOperation getOperation(String operationName) throws DfException
      Description copied from interface: IDfClientX
      Factory method for creating a new operation object.

      The preferred approach is to use one of the getXxxx Operation 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:

      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 interface IDfClientX
      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:

    • getFile

      public IDfFile getFile(String filePath) throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new 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:

      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 interface IDfClientX
      Parameters:
      filePath - full path to the file.
      Returns:
      an IDfFile interface to the file.
      Throws:
      DfException - if the file path is equal to null.

    • getFormatRecognizer

      public IDfFormatRecognizer getFormatRecognizer(IDfSession session, String filePath, String suggestedFormat) throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new 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:

      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 interface IDfClientX
      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 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.
      Specified by:
      getMacFormatRecognizer in interface IDfClientX
      Parameters:
      session - an interface to a Documentum server session.
      dataForkPath - the full path to a data fork file
      resForkPath - the full path to a resource fork file
      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 the file's likely formats.
      Throws:
      DfException

    • getClientRegistry

      public IDfClientRegistry getClientRegistry() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new 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:

      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 interface IDfClientX
      Returns:
      an IDfClientRegistry interface to the client registry.
      Throws:
      DfException - if unable to access the client registry.

    • getDFCVersion

      public String getDFCVersion()
      Description copied from interface: IDfClientX
      Returns the current DFC version string.
      Specified by:
      getDFCVersion in interface IDfClientX
      Returns:
      a String containing the DFC version string, such as "4.2.13.283" if successful, otherwise, "Unknown".

    • getLocalClient32

      public IDfClient getLocalClient32() throws DfException
      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 interface IDfClientX
      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 interface IDfClientX

    • getTraceTime

      public boolean getTraceTime()
      Description copied from interface: IDfClientX
      Returns if the current DFC trace contains timing information.
      Specified by:
      getTraceTime in interface IDfClientX
      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 interface IDfClientX
      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 interface IDfClientX
      Returns:
      true if threading information is included in the trace or false 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 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")
      Specified by:
      getVirtualDocumentNodeFromToken in interface IDfClientX
      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

      public String ByteArrayInputStreamToString(ByteArrayInputStream bais)
      Description copied from interface: IDfClientX
      Converts a Java ByteArrayInputStream object into a String. Used to convert the results of IDfSysObject.getContent() into a string.
      Specified by:
      ByteArrayInputStreamToString in interface IDfClientX
      Parameters:
      bais - a Java ByteArrayInputStream object.
      Returns:
      a String extracted from the Java ByteArrayInputStream object

    • StringToByteArrayOutputStream

      public ByteArrayOutputStream StringToByteArrayOutputStream(String s)
      Description copied from interface: IDfClientX
      Converts a String into a Java ByteArrayOutputStream object. Used to call IDfSysObject.setContent(java.io.ByteArrayOutputStream).
      Specified by:
      StringToByteArrayOutputStream in interface IDfClientX
      Parameters:
      s - the string to convert into a Java ByteArrayOutputStream object.
      Returns:
      a Java ByteArrayOutputStream object

    • getXMLUtils

      public IDfXMLUtils getXMLUtils()
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfXMLUtils object that provides methods for XML related functions, like getApplicationByDTD, getObjectIdFromDRL , isXML, isHTML, and so on.
      Specified by:
      getXMLUtils in interface IDfClientX
      Returns:
      an IDfXMLUtils interface

    • getImportOperation

      public IDfImportOperation getImportOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfImportOperation object for importing one or more files into the repository.

      Specified by:
      getImportOperation in interface IDfClientX
      Returns:
      A new IDfImportOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getCheckinOperation

      public IDfCheckinOperation getCheckinOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfCheckinOperation object for checking in one or more checked out repository objects.
      Specified by:
      getCheckinOperation in interface IDfClientX
      Returns:
      a new IDfCheckinOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getExportOperation

      public IDfExportOperation getExportOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfExportOperation object for exporting one or more repository objects to the file system.
      Specified by:
      getExportOperation in interface IDfClientX
      Returns:
      a new IDfExportOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getPredictiveCachingOperation

      public IDfPredictiveCachingOperation getPredictiveCachingOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfPredictiveCachingOperation object for predictive content caching.
      Specified by:
      getPredictiveCachingOperation in interface IDfClientX
      Returns:
      a new IDfPredictiveCachingOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getCheckoutOperation

      public IDfCheckoutOperation getCheckoutOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfCheckoutOperation object for checking in one or more repository objects previously checked out.
      Specified by:
      getCheckoutOperation in interface IDfClientX
      Returns:
      a new IDfCheckoutOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getCancelCheckoutOperation

      public IDfCancelCheckoutOperation getCancelCheckoutOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfCancelCheckout object.
      Specified by:
      getCancelCheckoutOperation in interface IDfClientX
      Returns:
      a new IDfCancelCheckout object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getCopyOperation

      public IDfCopyOperation getCopyOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfCopyOperation object.
      Specified by:
      getCopyOperation in interface IDfClientX
      Returns:
      a new IDfCopyOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getDeleteOperation

      public IDfDeleteOperation getDeleteOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfDeleteOperation object.
      Specified by:
      getDeleteOperation in interface IDfClientX
      Returns:
      a new IDfDeleteOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getMoveOperation

      public IDfMoveOperation getMoveOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfMoveOperation object.
      Specified by:
      getMoveOperation in interface IDfClientX
      Returns:
      a new IDfMoveOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getXMLTransformOperation

      public IDfXMLTransformOperation getXMLTransformOperation() throws DfException
      Description copied from interface: IDfClientX
      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.
      Specified by:
      getXMLTransformOperation in interface IDfClientX
      Returns:
      a new IDfXMLTransformOperation object.
      Throws:
      DfException - if unable to instantiate the desired operation
      See Also:

    • getValidationOperation

      public IDfValidationOperation getValidationOperation() throws DfException
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfValidationOperation object.
      Specified by:
      getValidationOperation in interface IDfClientX
      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 to IDfContentPackageFactory object.
      Specified by:
      getContentPackageFactory in interface IDfClientX

    • getTracer

      public IDfTracer getTracer()
      Specified by:
      getTracer in interface IDfClientX

    • getLogger

      public IDfLogger getLogger()
      Specified by:
      getLogger in interface IDfClientX

    • getXMLDocType

      public IDfXMLDocType getXMLDocType()
      Description copied from interface: IDfClientX
      Factory method that contructs a new IDfXMLDocType object.
      Specified by:
      getXMLDocType in interface IDfClientX
      Returns:
      a new IDfXMLDocType object.
      See Also:

    • getPermit

      public IDfPermit getPermit()
      Description copied from interface: IDfClientX
      Factory method that contructs a new IDfPermit object.
      Specified by:
      getPermit in interface IDfClientX
      Returns:
      a new IDfPermit object.
      See Also:

    • getDocbrokerClient

      public IDfDocbrokerClient getDocbrokerClient() throws DfException
      Description copied from interface: IDfClientX
      Factory method that contructs a new IDfDocbrokerClient instance.
      Specified by:
      getDocbrokerClient in interface IDfClientX
      Throws:
      DfException
      See Also:

    • getAcsTransferPreferences

      public IDfAcsTransferPreferences getAcsTransferPreferences()
      Description copied from interface: IDfClientX
      Factory method that constructs a new IDfAcsTransferPreferences instance.
      Specified by:
      getAcsTransferPreferences in interface IDfClientX
      Returns:
      IDfAcsTransferPreferences object

    • getAcsClient

      public IDfAcsClient getAcsClient()
      Description copied from interface: IDfClientX
      Returns an IDfAcsClient object.
      Specified by:
      getAcsClient in interface IDfClientX
      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 new IDfXQueryTargets object.
      Specified by:
      getXQueryTargets in interface IDfClientX
      Parameters:
      targetCategory - - must be either IDfXQueryTargets.DF_XMLSTORE or IDfXQueryTargets.DF_FULLTEXT
      Returns:
      a new IDfXQueryTargets object
      Throws:
      DfException