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

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

public class WcmXMLPropDescs
extends WcmDocumentImpl

WcmDocumentImpl derived class for manipulating Property Description specific XML


Field Summary
static java.lang.String ELEM_ALLPROPDESC
          XPath for all propdescs
static java.lang.String ELEM_CLASSNAME
          XPath for classdesc name
static java.lang.String ELEM_PROPDESC
          XPath for a propdesc
static java.lang.String ELEM_PROPDESCS
          XPath for propdescs
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
ELEM_OBJECTSET, thisDoc
 
Constructor Summary
WcmXMLPropDescs(org.w3c.dom.Document newXMLPropDescs)
          Constructor takes the Property Descriptions Document object
 
Method Summary
 boolean getBooleanProp(java.lang.String propID, java.lang.String sXPath)
          Returns the value of the boolean property description with the given ID and XPath.
 boolean getBooleanPropBySymname(java.lang.String symname, java.lang.String sXPath)
          Returns the value of the boolean property description with the given ID and XPath.
 org.w3c.dom.Document getChoiceListXML(java.lang.String symName)
          Returns the choice list XML for the given property
 java.lang.String getClassName()
          Returns the name of this class
 org.w3c.dom.Element getProp(java.lang.String sID)
          Return the property description with the given ID
 org.w3c.dom.Element getProp(java.lang.String sID, java.lang.String sXPath)
          Return the property description matching the given ID and appended XPath
 org.w3c.dom.Element getPropByName(java.lang.String sName)
          Return the property description with the given ID
 org.w3c.dom.Element getPropByName(java.lang.String sName, java.lang.String sXPath)
          Return the property description matching the given name and appended XPath
 java.lang.String getPropCardinality(java.lang.String sId)
          Returns the cardinality of the given property description.
 java.lang.String getPropCardinalityByName(java.lang.String sName)
          Returns the cardinality of the given property description.
 java.lang.String getPropName(java.lang.String sId)
          Returns the symbolic name of the given property description.
 java.lang.String getPropNameBySymName(java.lang.String sName)
          Returns the name of the given property symbolic name.
 java.lang.String getPropType(java.lang.String sId)
          Returns the data type of the given property description.
 java.lang.String getPropTypeByName(java.lang.String sName)
          Returns the data type of the given property description.
 java.lang.String getPropValue(java.lang.String propID, java.lang.String sXPath)
          Returns the value of the property description with the given ID and XPath.
 java.lang.String getPropValueBySymname(java.lang.String symname, java.lang.String sXPath)
          Returns the value of the property description with the given ID and XPath.
 org.w3c.dom.Element getPropValues(java.lang.String sId)
          Returns the values of the property description with the given ID.
static WcmXMLPropDescs getXMLPropDescs(org.w3c.dom.Document newXMLPropDescs)
          Get method creates this object using the given Property Descriptions Document.
 
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_PROPDESC

public static final java.lang.String ELEM_PROPDESC
XPath for a propdesc

See Also:
Constant Field Values

ELEM_ALLPROPDESC

public static final java.lang.String ELEM_ALLPROPDESC
XPath for all propdescs

See Also:
Constant Field Values

ELEM_CLASSNAME

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

See Also:
Constant Field Values

ELEM_PROPDESCS

public static final java.lang.String ELEM_PROPDESCS
XPath for propdescs

See Also:
Constant Field Values
Constructor Detail

WcmXMLPropDescs

public WcmXMLPropDescs(org.w3c.dom.Document newXMLPropDescs)
Constructor takes the Property Descriptions Document object

Parameters:
newXMLPropDescs - The new Property Descriptions Document object
Method Detail

getXMLPropDescs

public static WcmXMLPropDescs getXMLPropDescs(org.w3c.dom.Document newXMLPropDescs)
Get method creates this object using the given Property Descriptions Document.

Parameters:
newXMLPropDescs - The Document to use
Returns:
WcmXMLPropDescs The new object

getClassName

public java.lang.String getClassName()
                              throws java.lang.Exception
Returns the name of this class

Returns:
The name of this class
Throws:
java.lang.Exception

getPropValue

public java.lang.String getPropValue(java.lang.String propID,
                                     java.lang.String sXPath)
                              throws java.lang.Exception
Returns the value of the property description with the given ID and XPath.

Parameters:
propID - The property ID of the property description.
sXPath - XPath appended to the property description XPath statement.
Returns:
A String which contains the value of the property description element.
Throws:
java.lang.Exception

getChoiceListXML

public org.w3c.dom.Document getChoiceListXML(java.lang.String symName)
                                      throws java.lang.Exception
Returns the choice list XML for the given property

Parameters:
symName - The property symbolic name
Returns:
Document A choice list XML Document
Throws:
java.lang.Exception

getPropValueBySymname

public java.lang.String getPropValueBySymname(java.lang.String symname,
                                              java.lang.String sXPath)
                                       throws java.lang.Exception
Returns the value of the property description with the given ID and XPath.

Parameters:
symname - The symbolicc name of the property description.
sXPath - XPath appended to the property description XPath statement.
Returns:
A String which contains the value of the property description element.
Throws:
java.lang.Exception

getBooleanProp

public boolean getBooleanProp(java.lang.String propID,
                              java.lang.String sXPath)
                       throws java.lang.Exception
Returns the value of the boolean property description with the given ID and XPath.

Parameters:
propID - The property ID of the property description.
sXPath - XPath appended to the property description XPath statement.
Returns:
A boolean which contains the value of the property description element.
Throws:
java.lang.Exception

getBooleanPropBySymname

public boolean getBooleanPropBySymname(java.lang.String symname,
                                       java.lang.String sXPath)
                                throws java.lang.Exception
Returns the value of the boolean property description with the given ID and XPath.

Parameters:
symname - The symname of the property description.
sXPath - XPath appended to the property description XPath statement.
Returns:
A boolean which contains the value of the property description element.
Throws:
java.lang.Exception

getPropType

public java.lang.String getPropType(java.lang.String sId)
                             throws java.lang.Exception
Returns the data type of the given property description.

Parameters:
sId - The ID of the property description to look at.
Returns:
The data type of the indicated property description.
Throws:
java.lang.Exception

getPropTypeByName

public java.lang.String getPropTypeByName(java.lang.String sName)
                                   throws java.lang.Exception
Returns the data type of the given property description.

Parameters:
sName - The name of the property description to look at.
Returns:
The data type of the indicated property description.
Throws:
java.lang.Exception

getPropNameBySymName

public java.lang.String getPropNameBySymName(java.lang.String sName)
                                      throws java.lang.Exception
Returns the name of the given property symbolic name.

Parameters:
sName - The symbolic name of the property description to look at.
Returns:
String The name of the indicated property description.
Throws:
java.lang.Exception

getPropName

public java.lang.String getPropName(java.lang.String sId)
                             throws java.lang.Exception
Returns the symbolic name of the given property description.

Parameters:
sId - The ID of the property description to look at.
Returns:
The symbolic name of the indicated property description.
Throws:
java.lang.Exception

getProp

public org.w3c.dom.Element getProp(java.lang.String sID,
                                   java.lang.String sXPath)
                            throws java.lang.Exception
Return the property description matching the given ID and appended XPath

Parameters:
sID - The property description ID
sXPath - The XPath statement to append
Returns:
The Property Description Element
Throws:
java.lang.Exception

getPropByName

public org.w3c.dom.Element getPropByName(java.lang.String sName,
                                         java.lang.String sXPath)
                                  throws java.lang.Exception
Return the property description matching the given name and appended XPath

Parameters:
sName - The property description name
sXPath - The XPath statement to append
Returns:
The Property Description Element
Throws:
java.lang.Exception

getPropByName

public org.w3c.dom.Element getPropByName(java.lang.String sName)
                                  throws java.lang.Exception
Return the property description with the given ID

Parameters:
sName - The property description symbolic name
Returns:
The Property Description Element
Throws:
java.lang.Exception

getProp

public org.w3c.dom.Element getProp(java.lang.String sID)
                            throws java.lang.Exception
Return the property description with the given ID

Parameters:
sID - The property description ID
Returns:
The Property Description Element
Throws:
java.lang.Exception

getPropCardinality

public java.lang.String getPropCardinality(java.lang.String sId)
                                    throws java.lang.Exception
Returns the cardinality of the given property description.

Parameters:
sId - The ID of the property description to look at.
Returns:
The cardinality value of the indicated property description.
Throws:
java.lang.Exception

getPropCardinalityByName

public java.lang.String getPropCardinalityByName(java.lang.String sName)
                                          throws java.lang.Exception
Returns the cardinality of the given property description.

Parameters:
sName - The name of the property description to look at.
Returns:
The cardinality value of the indicated property description.
Throws:
java.lang.Exception

getPropValues

public org.w3c.dom.Element getPropValues(java.lang.String sId)
                                  throws java.lang.Exception
Returns the values of the property description with the given ID.

Parameters:
sId - The property ID of the property description.
Returns:
A Element which contains the values of the property description element.
Throws:
java.lang.Exception


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