|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWInstructionDefinition | +--filenet.vw.api.VWSimpleInstruction
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.
VWException
, Serialized FormMethod 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 filenet.vw.api.VWInstructionDefinition |
getAction, getInstructionId |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public java.lang.String[] getParams()
public void setParams(java.lang.String[] theParams) throws VWException
theParams
- The String array of parameters for this
instructionVWException
- Thrown if the length of the params array
is not consistent with the number of parameters required
by the action property of this instruction.public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) throws VWException
validate
in class VWInstructionDefinition
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 from
previous calls to validate on other objects.
myStep
- a reference to the containing VWCompoundStepDefinitionVWException
- Thrown if a low-level error occurs
during the validation.VWValidationError
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is non-extensible, and cannot be modified in any way.
toXML
in class VWInstructionDefinition
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public java.lang.String toString()
toString
in class VWInstructionDefinition
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |