filenet.vw.api

Class VWRollbackInstruction

java.lang.Object

filenet.vw.api.VWInstructionDefinition

filenet.vw.api.VWRollbackInstruction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Methods

Modifier and Type	Method and Description
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) Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
void	validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)

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

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

Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)

Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.

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

Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).

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:

VWWorkflowCollectionDefinition, VWWorkflowDefinition

toString

public java.lang.String toString()

Gets the name of this rollback instruction.

Specified by:

toString in class VWInstructionDefinition

Returns:

A string representing this rollback instruction.