Process Class Relationships

filenet.vw.api
Class VWInstructionDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWInstructionDefinition
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
VWRollbackInstruction, VWSimpleInstruction, VWWFEInstruction

public abstract class VWInstructionDefinition
extends java.lang.Object
implements java.io.Serializable

This class represents an individual instruction within a compound step definition. Note that it is abstract and that its subclasses are listed in the section immediately above. An instruction comprises the following:

Since:
VWWS4.20
See Also:
VWMapDefinition, VWMapNode, VWCompoundStepDefinition, VWActionType, VWException, Serialized Form

Method Summary
 int getAction()
          Gets the action.
 int getInstructionId()
          Gets the instruction id.
abstract  java.lang.String toString()
          Gets a string representation of this object.
abstract  void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWInstructionDefinition object to the buffer specified by the input parameter.
abstract  void validate(VWSession theSession, java.util.Vector EDefHandler, VWCompoundStepDefinition myStep)
          Validate this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

validate

public abstract void validate(VWSession theSession,
                              java.util.Vector EDefHandler,
                              VWCompoundStepDefinition myStep)
                       throws VWException
Validate this object.
Parameters:
theSession - The session object if logged on. This object is needed for various parts of the validation process. The object may be null, but areas of validation that require a logon will not be validated.
EDefVector - a Vector to which will be added any VWValidationErrors found during this call, the Vector may already contain some validation errors from previous calls to validate on other objects.
myStep - a reference to the containing VWCompoundStepDefinition
Returns:
void, but the EDefVector will be updated to contain any validation errors found during this call.
Throws:
VWException - Thrown if an error occurs during the validation

toXML

public abstract void toXML(java.lang.StringBuffer theBuffer)
                    throws VWException
Appends an XML string that represents this VWInstructionDefinition object to the buffer specified by the input parameter.

Warning: This XML string is non-extensible, and cannot be modified in any way.

Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

toString

public abstract java.lang.String toString()
Gets a string representation of this object. Useful for debugging: allows caller to "print" a string identification of the object, usually the name.
Overrides:
toString in class java.lang.Object

getInstructionId

public int getInstructionId()
Gets the instruction id.
Returns:
the instruction id of the instruction

getAction

public int getAction()
Gets the action.
Returns:
the integer representation of the action of the instruction
See Also:
VWActionType


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