Collaboration API Documentation

com.filenet.bso.collaboration.tools
Class ConfigBase

java.lang.Object
  |
  +--com.filenet.bso.collaboration.tools.ConfigBase
Direct Known Subclasses:
CreateRole, InitConfig

public class ConfigBase
extends java.lang.Object


Field Summary
protected  java.lang.String COLLAB_SEC_ROLE_DEF
           
protected  com.filenet.wcm.api.Session m_session
           
protected  java.lang.String XML_HEADER
           
 
Constructor Summary
ConfigBase()
           
 
Method Summary
protected  void add(java.lang.String OSname, java.lang.String filename, java.lang.String foldername, org.w3c.dom.Document xmlDoc)
          This method is used to add a new document to an object store.
protected  void checkin(com.filenet.wcm.api.Document doc, org.w3c.dom.Document xmlDoc)
          This method checks in a document.
protected  com.filenet.wcm.api.Document checkout(java.lang.String filename, java.lang.String OSname)
          This is a generic method used to checkout a document named, filename, from the given object store, OSname.
protected  org.w3c.dom.Node getNodeNamed(org.w3c.dom.NodeList nodeList, java.lang.String name)
          Pick a node from a nodeList using using the node's name.
protected  com.filenet.wcm.api.Session getSession(java.lang.String username, java.lang.String password)
          Creates a session object for use with the Java API.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XML_HEADER

protected final java.lang.String XML_HEADER

COLLAB_SEC_ROLE_DEF

protected final java.lang.String COLLAB_SEC_ROLE_DEF

m_session

protected com.filenet.wcm.api.Session m_session
Constructor Detail

ConfigBase

public ConfigBase()
Method Detail

checkout

protected com.filenet.wcm.api.Document checkout(java.lang.String filename,
                                                java.lang.String OSname)
This is a generic method used to checkout a document named, filename, from the given object store, OSname. It is assumed that this is a Document object. This method always returns the current version of the object.
Parameters:
filename - - the name or ID of the document to be retrieved
OSname - - the name or ID of the object store from which this document will be retrieved.
Returns:
com.filenet.wcm.api.Document object

checkin

protected void checkin(com.filenet.wcm.api.Document doc,
                       org.w3c.dom.Document xmlDoc)
This method checks in a document. It assumes that the parameter, doc, references the Document object checked out from the object store. It also assumes that the document contains XML.
Parameters:
doc - - the com.filenet.wcm.api Document that was checked out
xmlDoc - - the new contents in XML form

add

protected void add(java.lang.String OSname,
                   java.lang.String filename,
                   java.lang.String foldername,
                   org.w3c.dom.Document xmlDoc)
This method is used to add a new document to an object store. It assumes that the content of the document is XML. The document will be filed in the object store,OSname, and under the folder, foldername.
Parameters:
OSname - - The name of the object store where the document will be stored
filename - - The name the document will have in the object store
foldername - - The name of the folder it will be filed under
xmlDoc - - The XML which will form the content of the document

getSession

protected com.filenet.wcm.api.Session getSession(java.lang.String username,
                                                 java.lang.String password)
Creates a session object for use with the Java API.
Parameters:
username - - user to authenticate with
password - - password to authenticate with
Returns:
Session object containing authentication information with which to make Java API calls.

getNodeNamed

protected org.w3c.dom.Node getNodeNamed(org.w3c.dom.NodeList nodeList,
                                        java.lang.String name)
Pick a node from a nodeList using using the node's name. Assumes that the named node exists in the nodeList. If not, null is returned.
Parameters:
nodeList - - list of nodes
name - - node's name to retrieve.
Returns:
 

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.