Process Class Relationships

filenet.vw.api
Class VWRollbackInstruction

java.lang.Object
  |
  +--filenet.vw.api.VWInstructionDefinition
        |
        +--filenet.vw.api.VWRollbackInstruction
All Implemented Interfaces:
java.io.Serializable

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

Class encapsulates rollback instructions in a compound step definition.

Since:
VWWS4.20
See Also:
VWException, Serialized Form

Method Summary
 java.lang.String getCompCall()
          Get the compensation call instruction sheet name for this rollback operation.
 java.lang.String[] getParams()
          Get the parameters of this instruction.
 java.lang.String getReDo()
          Get the value of this instruction's re-do expression property.
 void setCompCall(java.lang.String theCompCallIS)
          Change the value of this instruction's compensation call instruction sheet name property.
 void setParams(java.lang.String[] theParams)
          Change the value of this instruction's params property.
 void setReDo(java.lang.String theReDoExpr)
          Change the value of this instruction's re-do expression property.
 java.lang.String toString()
          Gets the name of this rollback instruction
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWRollbackInstruction object to the buffer specified by the input parameter.
 void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep)
          Validate this VWRollbackInstruction 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

getParams

public java.lang.String[] getParams()
Get the parameters of this instruction.
Returns:
List of parameters for this instruction

setParams

public void setParams(java.lang.String[] theParams)
               throws VWException
Change the value of this instruction's params property.
Parameters:
theParams - the array of parameters for this instruction
Throws:
VWException - if an error occurs.

getCompCall

public java.lang.String getCompCall()
Get the compensation call instruction sheet name for this rollback operation.
Returns:
the compensation call instruction sheet name for this rollback operation, may be null.

setCompCall

public void setCompCall(java.lang.String theCompCallIS)
                 throws VWException
Change the value of this instruction's compensation call instruction sheet name property.
Parameters:
theCompCallIS - The name of the compensation call instruction sheet for this rollback operation.
Throws:
VWException - if an error occurs.

getReDo

public java.lang.String getReDo()
Get the value of this instruction's re-do expression property.
Returns:
The value of this rollback operation's re-do expression.

setReDo

public void setReDo(java.lang.String theReDoExpr)
             throws VWException
Change the value of this instruction's re-do expression property.
Parameters:
theReDoExpr - The new value of this rollback operation's re-do expression.
Throws:
VWException - if an error occurs.

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep)
              throws VWException
Validate this VWRollbackInstruction object.
Overrides:
validate in class VWInstructionDefinition
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 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 - If an error occurs during the validation

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWRollbackInstruction 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 the name of this rollback instruction
Overrides:
toString in class VWInstructionDefinition
Returns:
A string representing this rollback instruction.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.