Process API

filenet.vw.api
Class VWInstructionDefinition

java.lang.Object
  extended by filenet.vw.api.VWInstructionDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
VWInvokeInstruction, VWReceiveInstruction, VWReplyInstruction, VWRollbackInstruction, VWSimpleInstruction, VWWFEInstruction

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

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
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.
 int getAction()
          Gets the action.
 int getInstructionId()
          Gets the instruction id.
 VWCompoundStepDefinition getStep()
          get a reference to the containing VWCompound step definition.
abstract  java.lang.String toString()
          Gets a string representation of this object.
abstract  void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
abstract  void validate(VWSession theSession, java.util.Vector EDefHandler, VWCompoundStepDefinition myStep)
          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.


_get_FILE_AUTHOR

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


_get_FILE_REVISION

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


validate

public abstract void validate(VWSession theSession,
                              java.util.Vector EDefHandler,
                              VWCompoundStepDefinition myStep)
                       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.
EDefHandler - 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.

myStep - The VWCompoundStepDefinition object containing this event.
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 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 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

getStep

public VWCompoundStepDefinition getStep()
get a reference to the containing VWCompound step definition.


Process API

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