|
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
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.
VWException
, Serialized FormMethod 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 |
public java.lang.String[] getParams()
public void setParams(java.lang.String[] theParams) throws VWException
theParams
- The array of parameters for this instructionVWException
- 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 instructionVWException
- public java.lang.String getReDo()
public void setReDo(java.lang.String theReDoExpr) throws VWException
theReDoExpr
- This rollback instruction's new re-do
expressionVWException
- public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) throws VWException
validate
in class VWInstructionDefinition
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.VWException
- 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 |