filenet.vw.api
Class VWSimpleInstruction
java.lang.Object
|
+--filenet.vw.api.VWInstructionDefinition
|
+--filenet.vw.api.VWSimpleInstruction
- All Implemented Interfaces:
- java.io.Serializable
- 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 |
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 that represents this VWSimpleInstruction object
to the buffer specified by the input parameter. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this VWSimpleInstruction object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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 VWSimpleInstruction object.
- Overrides:
validate
in class VWInstructionDefinition
- Parameters:
theSession
- The session object if logged on. A null
object is valid, but in such a case, areas of validation that
require a logon will not be validated, since this object
is needed for various parts of the validation process.EDefVector
- a Vector to which will be added any VWValidationErrors found during this call, the Vector
may already contain some validation errors 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 a low-level error occurs
during the validation.- See Also:
VWValidationError
toXML
public void toXML(java.lang.StringBuffer theBuffer)
throws VWException
- Appends an XML string that represents this VWSimpleInstruction object
to the buffer specified by the input parameter.
- Overrides:
toXML
in class VWInstructionDefinition
- Parameters:
theBuffer
- A string buffer that this method will append with
XML content.- Throws:
VWException
- - See Also:
VWXMLUtil
toString
public java.lang.String toString()
- Gets a String representing this Instruction.
- Overrides:
toString
in class VWInstructionDefinition
- Returns:
- A String representing this Instruction.
Copyright © 2002 FileNET Corporation. All rights reserved.