|
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
This class represents an individual instruction within a compound step definition. Note that it is abstract and that its subclasses are listed in the section immediately above. An instruction comprises the following:
Below are some common examples of needed parameters:
VWMapDefinition
,
VWMapNode
,
VWCompoundStepDefinition
,
VWActionType
,
VWException
, Serialized FormMethod Summary | |
int |
getAction()
Gets the action. |
int |
getInstructionId()
Gets the instruction id. |
abstract java.lang.String |
toString()
Gets a string representation of this object. |
abstract void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWInstructionDefinition object to the buffer specified by the input parameter. |
abstract void |
validate(VWSession theSession,
java.util.Vector EDefHandler,
VWCompoundStepDefinition myStep)
Validate this object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public abstract void validate(VWSession theSession, java.util.Vector EDefHandler, VWCompoundStepDefinition myStep) throws VWException
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 from previous calls to validate on other
objects.myStep
- a reference to the containing VWCompoundStepDefinitionVWException
- Thrown if an error occurs during the validationpublic abstract void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is non-extensible, and cannot be modified in any way.
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public abstract java.lang.String toString()
toString
in class java.lang.Object
public int getInstructionId()
public int getAction()
VWActionType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |