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

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
      extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
Direct Known Subclasses:
WcmXMLProperties, XMLTreeModule

public class WcmXMLObject
extends WcmDocumentImpl

WcmDocumentImpl derived class for manipulating the Object Level specific XML


Field Summary
static java.lang.String ELEM_CLASSID
          XPath for class Id
static java.lang.String ELEM_CLASSNAME
          XPath for class name
static java.lang.String ELEM_OBJECT
          XPath for object node
static java.lang.String ELEM_OBJECTSTORE
          XPath for target node
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
ELEM_OBJECTSET, thisDoc
 
Constructor Summary
WcmXMLObject(org.w3c.dom.Document newXMLObject)
          Constructor takes the Document object to implement
 
Method Summary
 org.w3c.dom.Element getClassdescElement()
          Returns the classdesc Element if it exists
 java.lang.String getClassId()
          Returns the class Id or null if not yet set.
 java.lang.String getClassName()
          Returns the classdesc name or null if not yet set.
 org.w3c.dom.Element getObjectElement()
          Returns the folder or document Element
 java.lang.String getObjectId()
          Returns the Object Id
 org.w3c.dom.Element getObjectStoreElement()
          Returns the Object Store Element
 java.lang.String getObjectStoreId()
          Returns the Object Store Name/Id
 java.lang.String getObjectTagValue(java.lang.String sTag)
          Get the object level tag's value
protected  java.lang.String getObjectXPath()
          XPath for Object Node
static WcmXMLObject getXMLObject()
          get method returns a new instance of this object
static WcmXMLObject getXMLObject(org.w3c.dom.Document newXMLObject)
          get method creates or contains the Document as one of this type
 boolean setClassDescription(org.w3c.dom.Element oRoot, java.lang.String sId, java.lang.String sLabel, java.lang.String sAllowsInst, java.lang.String sSelectable)
          Creates the Class description Element and sets the sub Elements to the values specified
 org.w3c.dom.Element setObjectStoreId(java.lang.String sObjectStoreName)
          Sets the objectStore ID to the indicated value.
 org.w3c.dom.Element setObjectTagValue(java.lang.String sTag, java.lang.String sValue)
          Set the object level tag's value
protected  void setObjectXPath(java.lang.String newObjectXPath)
          new XPath for object node
 
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
 

Field Detail

ELEM_OBJECT

public static final java.lang.String ELEM_OBJECT
XPath for object node

See Also:
Constant Field Values

ELEM_OBJECTSTORE

public static final java.lang.String ELEM_OBJECTSTORE
XPath for target node

See Also:
Constant Field Values

ELEM_CLASSID

public static final java.lang.String ELEM_CLASSID
XPath for class Id

See Also:
Constant Field Values

ELEM_CLASSNAME

public static final java.lang.String ELEM_CLASSNAME
XPath for class name

See Also:
Constant Field Values
Constructor Detail

WcmXMLObject

public WcmXMLObject(org.w3c.dom.Document newXMLObject)
Constructor takes the Document object to implement

Parameters:
newXMLObject - The new Document object
Method Detail

getXMLObject

public static WcmXMLObject getXMLObject()
get method returns a new instance of this object

Returns:
WcmXMLObject The new WcmObject object

getXMLObject

public static WcmXMLObject getXMLObject(org.w3c.dom.Document newXMLObject)
get method creates or contains the Document as one of this type

Parameters:
newXMLObject - The Document to contain
Returns:
WcmXMLObject The new WcmXMLObject object

getObjectXPath

protected java.lang.String getObjectXPath()
                                   throws java.lang.Exception
XPath for Object Node

Returns:
Throws:
java.lang.Exception

setObjectXPath

protected void setObjectXPath(java.lang.String newObjectXPath)
                       throws java.lang.Exception
new XPath for object node

Parameters:
newObjectXPath -
Throws:
java.lang.Exception

getObjectElement

public org.w3c.dom.Element getObjectElement()
                                     throws java.lang.Exception
Returns the folder or document Element

Returns:
The folder or document Element
Throws:
java.lang.Exception

getObjectTagValue

public java.lang.String getObjectTagValue(java.lang.String sTag)
                                   throws java.lang.Exception
Get the object level tag's value

Parameters:
sTag - The tag name
Returns:
The value of the element with the given tag name
Throws:
java.lang.Exception

setObjectTagValue

public org.w3c.dom.Element setObjectTagValue(java.lang.String sTag,
                                             java.lang.String sValue)
                                      throws java.lang.Exception
Set the object level tag's value

Parameters:
sTag - The tag name
sValue - The value to give the element
Returns:
The named tag's element
Throws:
java.lang.Exception

getObjectStoreElement

public org.w3c.dom.Element getObjectStoreElement()
                                          throws java.lang.Exception
Returns the Object Store Element

Returns:
The new objectstore Element
Throws:
java.lang.Exception

getObjectStoreId

public java.lang.String getObjectStoreId()
                                  throws java.lang.Exception
Returns the Object Store Name/Id

Returns:
The objectstore Name
Throws:
java.lang.Exception

getObjectId

public java.lang.String getObjectId()
                             throws java.lang.Exception
Returns the Object Id

Returns:
The object Id
Throws:
java.lang.Exception

setObjectStoreId

public org.w3c.dom.Element setObjectStoreId(java.lang.String sObjectStoreName)
                                     throws java.lang.Exception
Sets the objectStore ID to the indicated value.

Parameters:
sObjectStoreName - The objectStore ID value to use.
Returns:
The objectstore's name Element if successful
Throws:
java.lang.Exception

getClassId

public java.lang.String getClassId()
                            throws java.lang.Exception
Returns the class Id or null if not yet set.

Returns:
A string representing the class id
Throws:
java.lang.Exception

getClassName

public java.lang.String getClassName()
                              throws java.lang.Exception
Returns the classdesc name or null if not yet set.

Returns:
A string representing the class name
Throws:
java.lang.Exception

getClassdescElement

public org.w3c.dom.Element getClassdescElement()
                                        throws java.lang.Exception
Returns the classdesc Element if it exists

Returns:
The classdesc Element
Throws:
java.lang.Exception

setClassDescription

public boolean setClassDescription(org.w3c.dom.Element oRoot,
                                   java.lang.String sId,
                                   java.lang.String sLabel,
                                   java.lang.String sAllowsInst,
                                   java.lang.String sSelectable)
                            throws java.lang.Exception
Creates the Class description Element and sets the sub Elements to the values specified

Parameters:
oRoot - The root folder or document Element - included to make it safer to use this object and avoid two methods
sId - The class description ID
sLabel - The class description name
sAllowsInst - Indicates if this class description allows instances
sSelectable - Indicates if this class is selectable
Returns:
boolean indicating if the class was changed
Throws:
java.lang.Exception


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