filenet.vw.api

Class VWXMLData

java.lang.Object

filenet.vw.api.VWXMLData

All Implemented Interfaces:

java.io.Serializable

public final class VWXMLData
extends java.lang.Object
implements java.io.Serializable

Use this class to retrieve or set schemas, elements, and XML Strings for the workflow fields that are the XML data fields for Web Services.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VWXMLData() Public constructor
VWXMLData(java.lang.String theNewXML, java.lang.String theNewSchemaName, java.lang.String theNewElementName) Public constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementName() Gets the element name
java.lang.String	getSchemaName() Gets the schema name
java.lang.String	getXML() Gets the XML string
void	setElementName(java.lang.String theNewElementName) Sets the element name.
void	setSchemaName(java.lang.String theNewSchemaName) Sets the schema name.
void	setXML(java.lang.String theNewXML) Sets the XML string
java.lang.String	toString() Gets a string representation of this object.
void	toXML(java.lang.StringBuffer theBuffer) Appends an XML string that represents this VWXMLData object to the buffer specified by the input parameter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VWXMLData

public VWXMLData()

Public constructor

VWXMLData

public VWXMLData(java.lang.String theNewXML,
                 java.lang.String theNewSchemaName,
                 java.lang.String theNewElementName)
          throws VWException

Public constructor.

Parameters:

theNewXML - The new XML string value

theNewSchemaName - The new schema name

theNewElementName - The new element name

Throws:

VWException

Method Detail

getXML

public java.lang.String getXML()

Gets the XML string

Returns:

The XML string

getElementName

public java.lang.String getElementName()

Gets the element name

Returns:

The element name

getSchemaName

public java.lang.String getSchemaName()

Gets the schema name

Returns:

The schema name

setXML

public void setXML(java.lang.String theNewXML)
            throws VWException

Sets the XML string

Parameters:

theNewXML - The new XML string value

Throws:

VWException

setElementName

public void setElementName(java.lang.String theNewElementName)
                    throws VWException

Sets the element name. Element name can only be set at design time.

Parameters:

theNewElementName - The new element name

Throws:

VWException - thrown if the caller attempts to set the element name on a run time VWXMLData object.

setSchemaName

public void setSchemaName(java.lang.String theNewSchemaName)
                   throws VWException

Sets the schema name. The schema name can only be set at design time.

Parameters:

theNewSchemaName - The new schema name

Throws:

VWException - thrown if the caller attempts to set the schema name on a runtime VWXMLData object.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException

Appends an XML string that represents this VWXMLData object to the buffer specified by the input parameter.

Cautions: This XML string is non-extensible, and cannot be modified in any way. This general list of properties currently contained in the appended string is subject to change without notice.

Parameters:

theBuffer - A StringBuffer that the method will append with XML content.

Throws:

VWException

toString

public java.lang.String toString()

Gets a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

the XML string