com.filenet.wcm.toolkit.server.util.xml
Class XMLTreeModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
      extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
          extended bycom.filenet.wcm.toolkit.server.util.xml.XMLTreeModule

Deprecated. WcmXMLObject derived class for manipulating the Object Level specific XML

public class XMLTreeModule
extends WcmXMLObject


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
ELEM_CLASSID, ELEM_CLASSNAME, ELEM_OBJECT, ELEM_OBJECTSTORE
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
ELEM_OBJECTSET, thisDoc
 
Constructor Summary
XMLTreeModule(org.w3c.dom.Document newXMLTreeModule)
          Deprecated. Constructor takes the Document object to implement
 
Method Summary
static XMLTreeModule getXMLTreeModule()
          Deprecated. get method returns a new instance of this object
static XMLTreeModule getXMLTreeModule(org.w3c.dom.Document newXMLTreeModule)
          Deprecated. get method creates or contains the Document as one of this type
 boolean importXML(org.w3c.dom.Document inputXML, java.lang.String parent, boolean refresh)
          Deprecated. Import XML to tree module format
 void openNode(java.lang.String selectedID, java.lang.String nodeName)
          Deprecated. Open the indicated node along with any parent nodes.
 void openRoot()
          Deprecated. Open the root node
 boolean toggleNode(java.lang.String selectedID, boolean on)
          Deprecated. Toggle the node with the indicated id.
 boolean toggleObjectStore(java.lang.String objectStore, boolean on)
          Deprecated. Toggle an object store node.
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
getClassdescElement, getClassId, getClassName, getObjectElement, getObjectId, getObjectStoreElement, getObjectStoreId, getObjectTagValue, getObjectXPath, getXMLObject, getXMLObject, setClassDescription, setObjectStoreId, setObjectTagValue, setObjectXPath
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
createCDATAChildElement, createChildElement, createChildElement, createNamespace, getDocumentImpl, getElement, getElement, getElementText, getNodeList, getThis
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLTreeModule

public XMLTreeModule(org.w3c.dom.Document newXMLTreeModule)
Deprecated. 
Constructor takes the Document object to implement

Parameters:
newXMLTreeModule - The new Document object
Method Detail

getXMLTreeModule

public static XMLTreeModule getXMLTreeModule()
Deprecated. 
get method returns a new instance of this object

Returns:
XMLTreeModule The new WcmObject object

getXMLTreeModule

public static XMLTreeModule getXMLTreeModule(org.w3c.dom.Document newXMLTreeModule)
Deprecated. 
get method creates or contains the Document as one of this type

Parameters:
newXMLTreeModule - The Document to contain
Returns:
XMLTreeModule The new XMLTreeModule object

importXML

public boolean importXML(org.w3c.dom.Document inputXML,
                         java.lang.String parent,
                         boolean refresh)
                  throws java.lang.Exception
Deprecated. 
Import XML to tree module format

Parameters:
inputXML - XML from navigation or authoring DP
parent - ID of parent node, null for top
Returns:
false if parent not found
Throws:
java.lang.Exception

openNode

public void openNode(java.lang.String selectedID,
                     java.lang.String nodeName)
              throws java.lang.Exception
Deprecated. 
Open the indicated node along with any parent nodes.

Parameters:
selectedID - Node to open
nodeName - Parent node names (plural)
Throws:
java.lang.Exception - Throws exception on error

toggleNode

public boolean toggleNode(java.lang.String selectedID,
                          boolean on)
                   throws java.lang.Exception
Deprecated. 
Toggle the node with the indicated id. on=true forces node toggle on.

Parameters:
selectedID - Id of node to toggle
on - Force on if true
Returns:
boolean true if the node is opened
Throws:
java.lang.Exception - Throws exception on error

toggleObjectStore

public boolean toggleObjectStore(java.lang.String objectStore,
                                 boolean on)
                          throws java.lang.Exception
Deprecated. 
Toggle an object store node. on=true forces node toggle on.

Parameters:
objectStore - The object Store name node to toggle
on - Force on if true
Returns:
boolean true if the node is opened
Throws:
java.lang.Exception - Throw exception on error

openRoot

public void openRoot()
              throws java.lang.Exception
Deprecated. 
Open the root node

Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.