|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWInstructionDefinition
filenet.vw.api.VWRollbackInstruction
public final class 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 | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
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 representing this instance to the buffer specified. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
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 |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String[] getParams()
public void setParams(java.lang.String[] theParams) throws VWException
theParams
- The array of parameters for this instruction
VWException
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 instruction
VWException
public java.lang.String getReDo()
public void setReDo(java.lang.String theReDoExpr) throws VWException
theReDoExpr
- This rollback instruction's new re-do
expression
VWException
public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) throws VWException
validate
in class VWInstructionDefinition
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.
VWException
- Thrown if an error occurs during the validation.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in class VWInstructionDefinition
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public java.lang.String toString()
toString
in class VWInstructionDefinition
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |