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

This class encapsulates rollback instructions for a compound step definition. For information on using rollback instructions, see the online Designer Help, under Steps>System Steps>Rollback System Instructions.

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()
          Gets the parameters of this instruction.
 java.lang.String getReDo()
          Gets this instruction's re-do expression.
 void setCompCall(java.lang.String theCompCallIS)
          Initialize or modify the name of the compensation call instruction sheet for this rollback instruction.
 void setParams(java.lang.String[] theParams)
          Initialize or modify the parameters of this instruction.
 void setReDo(java.lang.String theReDoExpr)
          Initialize or modify this rollback instruction's re-do expression.
 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)
          Validates the properties of 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()
Gets the parameters of this instruction.
Returns:
List of parameters for this instruction

setParams

public void setParams(java.lang.String[] theParams)
               throws VWException
Initialize or modify the parameters of this instruction.
Parameters:
theParams - The array of parameters for this instruction
Throws:
VWException -  

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, or null if there is no compensation call instruction sheet name for this rollback operation.

setCompCall

public void setCompCall(java.lang.String theCompCallIS)
                 throws VWException
Initialize or modify the name of the compensation call instruction sheet for this rollback instruction.
Parameters:
theCompCallIS - The name of the compensation call instruction sheet for this rollback instruction
Throws:
VWException -  

getReDo

public java.lang.String getReDo()
Gets this instruction's re-do expression.
Returns:
This rollback instruction's re-do expression

setReDo

public void setReDo(java.lang.String theReDoExpr)
             throws VWException
Initialize or modify this rollback instruction's re-do expression. The re-do expression must be either null or a valid boolean expression.
Parameters:
theReDoExpr - This rollback instruction's new re-do expression
Throws:
VWException -  

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep)
              throws VWException
Validates the properties of this VWRollbackInstruction object.
Overrides:
validate in class VWInstructionDefinition
Parameters:
theSession - The logged-on session object, or null. Null will omit validation checks that require a logon.
EDefVector - a Vector that is appended with VWValidationError for errors detected; validation error objects from previous validation calls remain in their EDefVector vector locations.
myStep - The containing VWCompoundStepDefinition for this VWRollbackInstruction object.
Returns:
Void. Note: The EDefVector will be appended with errors detected by this call.
Throws:
VWException -  

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.

Warning: This XML string is non-extensible, and cannot be modified in any way.

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.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.