Process Class Relationships

filenet.vw.api
Class VWXMLUtil

java.lang.Object
  |
  +--filenet.vw.api.VWXMLUtil

public final class VWXMLUtil
extends java.lang.Object

VWXMLUtil creates and processes blocks of XML.

Since:
VWWS4.20
See Also:
VWException

Constructor Summary
VWXMLUtil()
           
 
Method Summary
static java.lang.String getNameSpace()
          Gets the namespace string used by this class.
static java.lang.String makeXMLBlock(IVWtoXML apiObject)
          Creates an XML block from a filenet.vw.api object that implements the IVWtoXML interface.
static java.lang.String makeXMLBlock(IVWtoXML[] apiObjects, java.lang.String theGroupTag)
          Creates XML header information and XML for each of the objects contained in an input array of filenet.vw.api objects that implement the IVWtoXML interface.
static void setDatePattern(java.lang.String pattern)
          Sets the date pattern format for runtime toXML methods, such as VWQueueElement.toXML(StringBuffer).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VWXMLUtil

public VWXMLUtil()
Method Detail

makeXMLBlock

public static java.lang.String makeXMLBlock(IVWtoXML[] apiObjects,
                                            java.lang.String theGroupTag)
                                     throws VWException
Creates XML header information and XML for each of the objects contained in an input array of filenet.vw.api objects that implement the IVWtoXML interface.
Parameters:
apiObjects - An array of filenet.vw.api objects that implement the IVWtoXML interface.
theGroupTag - A string which will be used as an enclosing tag around the XML for the apiObjects array. This group tag may aid in parsing the resulting block of XML.
Returns:
A string containing XML representing the objects passed in the input apiObjects parameter.
Throws:
VWException - Thrown when this method cannot create a string containing XML header information and XML for each of the objects contained in an input array of filenet.vw.api objects.

makeXMLBlock

public static java.lang.String makeXMLBlock(IVWtoXML apiObject)
                                     throws VWException
Creates an XML block from a filenet.vw.api object that implements the IVWtoXML interface.
Parameters:
apiObject - A filenet.vw.api object that implements the IVWtoXML interface.
Returns:
A string containing an XML block that represents this filenet.vw.api object.
Throws:
VWException - Thrown if a low-level error makes this method unable to create an XML block that corresponds to the passed in filenet.vw.api object that implements the IVWtoXML interface.

getNameSpace

public static java.lang.String getNameSpace()
Gets the namespace string used by this class.
Returns:
The namespace used by this class.

setDatePattern

public static void setDatePattern(java.lang.String pattern)
                           throws VWException
Sets the date pattern format for runtime toXML methods, such as VWQueueElement.toXML(StringBuffer). By default, the pattern used represents UTC ISO condensed date format as follows:

"yyyyMMdd'T'HHmmss'Z'".

The new pattern remains in effect until either the calling program finishes or this method is again invoked to change the pattern.

Parameters:
pattern - The DateFormat pattern (or mask) to be used in runtime toXML methods. These patterns are described under the Sun Java site for java.text.SimpleDateFormat.
Throws:
VWException -  
See Also:
java.text.SimpleDateFormat


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.