Process API

filenet.vw.api
Class VWSimpleInstruction

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

public final class VWSimpleInstruction
extends VWInstructionDefinition
implements java.io.Serializable

The VWSimpleInstruction class encapsulates simple instructions in a compound step definition. In this implementation, every instruction except Rollback and WaitForEvent can be represented by a VWSimpleInstruction object. Simple instructions have fixed parameters or variable parameters which can be represented in a one-dimensional array of Strings.

Since:
VWWS4.20
See Also:
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.
 java.lang.String[] getParams()
          Gets the parameters of this instruction.
 void setParams(java.lang.String[] theParams)
          Changes the value of this instruction's params property.
 java.lang.String toString()
          Gets a String representing this Instruction.
 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, VWCompoundStepDefinition myStep)
          Validates this instance, appending any validation errors found to the specified Vector object.
 
Methods inherited from class filenet.vw.api.VWInstructionDefinition
getAction, getInstructionId, getStep
 
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.


getParams

public java.lang.String[] getParams()
Gets the parameters of this instruction.

Returns:
An array of Strings that contains the list of parameters for this instruction

setParams

public void setParams(java.lang.String[] theParams)
               throws VWException
Changes the value of this instruction's params property.

Parameters:
theParams - The String array of parameters for this instruction
Throws:
VWException - Thrown if the length of the params array is not consistent with the number of parameters required by the action property of this instruction.

validate

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

Specified by:
validate in class VWInstructionDefinition
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.

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

Specified by:
toXML in class VWInstructionDefinition
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 representing this Instruction.

Specified by:
toString in class VWInstructionDefinition
Returns:
A String representing this Instruction.

Process API

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