|
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.VWWFEInstruction
public final class VWWFEInstruction
This class encapsulates wait for event instructions in a compound step definition.
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. |
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 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 representing this instance to the buffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL 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 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
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
The returned array has the same number of elements as the number of events in the wait for event instructions. There are no empty elements in the array. If no events are defined for this instance, the method returns null.
VWException
- Thrown if the events cannot be returned.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 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 void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
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
- A VWCompoundStepDefinition object for the referenced step.
VWException
- Thrown if the validation cannot be performed.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 |