|
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.VWWFEInstruction
This class encapsulates wait for event instructions in a compound step definition.
VWException
, Serialized FormMethod Summary | |
VWEventDefinition |
createEvent(java.lang.String theWCName,
java.lang.String theOperator,
java.lang.String theValue)
Creates an event in this VWWFEInstruction instance. |
java.lang.String |
getEventNumLoc()
Get the value of this instruction's eventNumLoc expression property. |
VWEventDefinition[] |
getEvents()
Gets the events contained in this VWWFEInstruction instance. |
java.lang.String |
getTimeOut()
Get the value of this instruction's timeOut expression property. |
void |
setEventNumLoc(java.lang.String theEventNumLoc)
Change the value of this instruction's eventNumLoc expression property. |
void |
setEvents(VWEventDefinition[] theEvents)
Sets the events contained in this VWWFEInstruction instance. |
void |
setTimeOut(java.lang.String theTimeOut)
Change the value of this instruction's timeOut 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 VWWFEInstruction instance to the buffer specified by the input parameter. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validate this VWWFEInstruction 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 getTimeOut()
public void setTimeOut(java.lang.String theTimeOut) throws VWException
theTimeOut
- The new value of this instruction's timeOut expression property.
A time expression representing the maximum number of minutes to wait for an event to occur.
A value of "0" means wait forever. This parameter cannot be null.VWException
- public java.lang.String getEventNumLoc()
public void setEventNumLoc(java.lang.String theEventNumLoc) throws VWException
theEventNumLoc
- The new value of this instruction's
eventNumLoc expression property.
A numeric Lvalue expression that is the location in which the row
number of the event causing the wait for event to expire is stored.VWException
- public VWEventDefinition[] getEvents() throws VWException
VWException
- Thrown if it
cannot get the events.public void setEvents(VWEventDefinition[] theEvents) throws VWException
theEvents
- An array of VWEventDefinition objects. The array may
not contain any null elements. The array may be null.VWException
- Thrown if it
cannot set the events.public VWEventDefinition createEvent(java.lang.String theWCName, java.lang.String theOperator, java.lang.String theValue) throws VWException
theWCName
- The new value of this event's WorkClass name
property. This non-null value is the name of the work class that
will trigger this event.theOperator
- The new value of this event's
comparison operator property. To determine if the event has
occurred, the operator is used to compare this event's value
property with the F_Tag field of the WorkClass that
triggered this event.
This non-null operator must be one of the following symbols: "=", ">", "<", "<>", "<=", or ">=".
theValue
- The new value of this event's value expression
property. This non-null value will be compared against the F_Tag
field of the WorkClass that triggered this event, using the
comparison operator in this event to determine if the event has
occurred.VWException
- Thrown if it cannot create the event.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 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
- 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 |