|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWSchema
public final class VWSchema
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.
VWWorkflowDefinition
,
VWXMLData
,
Serialized FormMethod 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 |
---|
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 java.lang.String getName()
public java.lang.String getSchema()
public void setSchema(java.lang.String theSchema)
theSchema
- The new schema text for this VWSchema object.public void setName(java.lang.String theName) throws VWException
theName
- Name value of this VWSchema object, which must
be unique within the workflow.
VWException
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
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.
VWException
- Thrown if an error occurs during the validation.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone()
VWSchema
object.
clone
in class java.lang.Object
public java.lang.String getFileName()
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.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |