|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWXMLUtil
public final class VWXMLUtil
VWXMLUtil creates and processes blocks of XML from
Process Engine API runtime objects
that implement the IVWtoXML
interface.
VWException
Constructor Summary | |
---|---|
VWXMLUtil()
|
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
static java.lang.String |
getNameSpace()
Gets the namespace string used by this class. |
static java.lang.String |
makeXMLBlock(IVWtoXML apiObject)
Creates XML header information and XML text representing runtime a Process Engine API object from a runtime Process Engine API object that implements the IVWtoXML interface. |
static java.lang.String |
makeXMLBlock(IVWtoXML[] apiObjects,
java.lang.String theGroupTag)
Creates XML header information and XML text representing runtime Process Engine API objects in an input array of runtime Process Engine 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) . |
static void |
setDateTimeZone(java.util.SimpleTimeZone TZone)
Sets the SimpleTimeZone used to format dates in 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 |
---|
public VWXMLUtil()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public static java.lang.String makeXMLBlock(IVWtoXML[] apiObjects, java.lang.String theGroupTag) throws VWException
IVWtoXML
interface.
You may create administration and configuration
XML blocks with VWXMLConfiguration.makeXMLBlock(IVWtoXML[])
.
apiObjects
- Array of
runtime Process Engine 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.
VWException
- Thrown for various causes, including an
invalid object in the input apiObjects argument.public static java.lang.String makeXMLBlock(IVWtoXML apiObject) throws VWException
IVWtoXML
interface.
You may create administration and configuration
XML blocks with VWXMLConfiguration.makeXMLBlock(IVWtoXML[])
.
apiObject
- Runtime Process Engine API object that implements
the IVWtoXML interface.
VWException
- Thrown for various causes, including an
invalid object in the input apiObjects argument.public static java.lang.String getNameSpace()
public static void setDatePattern(java.lang.String pattern) throws VWException
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.
pattern
- The DateFormat pattern (or mask) to be used
in runtime toXML methods. These patterns are described in the java.text.SimpleDateFormat class for your JDK.
VWException
public static void setDateTimeZone(java.util.SimpleTimeZone TZone) throws VWException
VWQueueElement.toXML(StringBuffer)
. By default, the time zone used
represents 'GMT', ( SimpleTimeZone(0,"UTC") ).
The new SimpleTimeZone remains in effect until either the calling program finishes or this method is again invoked to change the time zone.
TZone
- The SimpleTimeZone to be used
in runtime toXML methods. These time zones are described in the java.util.SimpleTimeZone class for your JDK.
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |