|
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.VWRollbackInstruction
Class encapsulates rollback instructions in a compound step definition.
VWException
, Serialized FormMethod 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 |
public java.lang.String[] getParams()
public void setParams(java.lang.String[] theParams) throws VWException
theParams
- the array of parameters for this instructionVWException
- if an error occurs.public java.lang.String getCompCall()
public void setCompCall(java.lang.String theCompCallIS) throws VWException
theCompCallIS
- The name of the compensation call instruction sheet for this rollback operation.VWException
- if an error occurs.public java.lang.String getReDo()
public void setReDo(java.lang.String theReDoExpr) throws VWException
theReDoExpr
- The new value of this rollback operation's re-do expression.VWException
- if an error occurs.public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) throws VWException
validate
in class VWInstructionDefinition
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 VWCompoundStepDefinitionVWException
- If an error occurs during the validationpublic void toXML(java.lang.StringBuffer theBuffer) throws VWException
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
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |