|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWInstructionDefinition
public abstract class 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 | |
---|---|
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. |
int |
getAction()
Gets the action. |
int |
getInstructionId()
Gets the instruction id. |
VWCompoundStepDefinition |
getStep()
get a reference to the containing VWCompound step definition. |
abstract java.lang.String |
toString()
Gets a string representation of this object. |
abstract void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
abstract void |
validate(VWSession theSession,
java.util.Vector EDefHandler,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
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 abstract void validate(VWSession theSession, java.util.Vector EDefHandler, VWCompoundStepDefinition myStep) throws VWException
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.EDefHandler
- 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 abstract void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public abstract java.lang.String toString()
toString
in class java.lang.Object
public int getInstructionId()
public int getAction()
VWActionType
public VWCompoundStepDefinition getStep()
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |