Process API

filenet.vw.api
Class VWSchema

java.lang.Object
  extended by filenet.vw.api.VWSchema
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public final class VWSchema
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class represents an XML schema that can be a property of a workflow definition. Create a schema with the VWWorkflowDefinition.createSchema(String) method. This method manages the format, text, naming, and validation of an XML schema for a workflow definition.

See Also:
VWWorkflowDefinition, VWXMLData, Serialized Form

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.
 java.lang.Object clone()
          Creates a clone of this VWSchema object.
 java.lang.String getFileName()
          Gets the name of the file that contained the schema used in the design-time schema.
 java.lang.String getName()
          Gets the name of this VWSchema object.
 java.lang.String getSchema()
          Gets the schema text of this VWSchema object.
 void setName(java.lang.String theName)
          Sets the name of this schema.
 void setSchema(java.lang.String theSchema)
          Sets the schema text of this VWSchema object.
 java.lang.String toString()
          Gets a string version of the schema name.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 void validate(VWSession theSession, java.util.Vector EDefVector)
          Validates this instance, appending any validation errors found to the specified Vector object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.

Returns:
the file author

_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.

Returns:
the file revision

getName

public java.lang.String getName()
Gets the name of this VWSchema object.

Returns:
The name of this VWSchema object.

getSchema

public java.lang.String getSchema()
Gets the schema text of this VWSchema object.

Returns:
The schema.

setSchema

public void setSchema(java.lang.String theSchema)
Sets the schema text of this VWSchema object.

Parameters:
theSchema - The new schema text for this VWSchema object.

setName

public void setName(java.lang.String theName)
             throws VWException
Sets the name of this schema.

Parameters:
theName - Name value of this VWSchema object, which must be unique within the workflow.
Throws:
VWException

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
Validates this instance, appending any validation errors found to the specified Vector object.

Parameters:
theSession - The current VWSession object if logged on. This is needed for various parts of the validation process. This can be null; however, areas of validation requiring a logon will not be validated.
EDefVector - A Vector to which will be added a VWValidationError object for each validation error found. This can be null; in this case, a new Vector is used.

Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.

Throws:
VWException - Thrown if an error occurs during the validation.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

toString

public java.lang.String toString()
Gets a string version of the schema name.

Overrides:
toString in class java.lang.Object
Returns:
The name of the schema.

clone

public java.lang.Object clone()
Creates a clone of this VWSchema object.

Overrides:
clone in class java.lang.Object
Returns:
a clone of this instance.

getFileName

public java.lang.String getFileName()
Gets the name of the file that contained the schema used in the design-time schema.

For runtime VWSchemas only: This will only be non-null if the design-time schema contained the name of a schema file instead of a schema. At run-time, the schema will be expanded to the contents of the file by the PE Server; however, some runtime applications will need to know the name of the file.

This method returns a non-null value only if this object comes from a workflow definition fetched from the PE server and the schema text for this VWSchema object at design-time was the name of a schema file rather than an XML schema.

Returns:
The name of the file specified in the setSchema call at design-time; otherwise, null.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.