VWWFEInstruction (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWInstructionDefinition
- - filenet.vw.api.VWWFEInstruction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWWFEInstruction
extends VWInstructionDefinition
implements java.io.Serializable
```
This class encapsulates wait for event instructions in a compound step definition.

Since:

VWWS4.20

See Also:

VWException, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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)` Deprecated. Use `VWWorkflowDefinition.write(java.io.OutputStream)` or `VWWorkflowDefinition.writeToFile(String)`.
`void`	`toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer)` Deprecated. Use `VWWorkflowCollectionDefinition.write(java.io.OutputStream)` or `VWWorkflowCollectionDefinition.writeToFile(String)`.
`void`	`validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep)` Deprecated. Use `VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)`

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
  - getTimeOut
```
public java.lang.String getTimeOut()
```
    Get the value of this instruction's timeOut expression property.
    
    Returns:
    
    The value of this instruction's timeOut expression.
  - setTimeOut
```
public void setTimeOut(java.lang.String theTimeOut)
                throws VWException
```
    Change the value of this instruction's timeOut expression property.
    
    Parameters:
    
    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.
    
    Throws:
    
    VWException
  - getEventNumLoc
```
public java.lang.String getEventNumLoc()
```
    Get the value of this instruction's eventNumLoc expression property.
    
    Returns:
    
    The value of this instruction's eventNumLoc expression.
  - setEventNumLoc
```
public void setEventNumLoc(java.lang.String theEventNumLoc)
                    throws VWException
```
    Change the value of this instruction's eventNumLoc expression property.
    
    Parameters:
    
    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.
    
    Throws:
    
    VWException
  - getEvents
```
public VWEventDefinition[] getEvents()
                              throws VWException
```
    Gets the events contained in this instance. If a translation source exists, the authored work class and instruction sheet names are translated for each event.
    Note: The translation is done only at run time, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    An array of VWEventDefinition objects for the events for this instance. If a translation source exists, the translated work class and instruction sheet names for the events are returned; otherwise, the authored names are returned.
    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.
    
    Throws:
    
    VWException - Thrown if the events cannot be returned.
  - setEvents
```
public void setEvents(VWEventDefinition[] theEvents)
               throws VWException
```
    Sets the events contained in this VWWFEInstruction instance.
    
    Parameters:
    
    theEvents - An array of VWEventDefinition objects. The array may not contain any null elements. The array may be null.
    
    Throws:
    
    VWException - Thrown if it cannot set the events.
  - createEvent
```
public VWEventDefinition createEvent(java.lang.String theWCName,
                                     java.lang.String theOperator,
                                     java.lang.String theValue)
                              throws VWException
```
    Creates an event in this VWWFEInstruction instance.
    
    Parameters:
    
    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.
    
    Returns:
    
    The new VWEventDefinition object.
    
    Throws:
    
    VWException - Thrown if it cannot create the event.
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
    
    Appends an XML string representing this instance to the buffer specified.
    Warning: This XML string is nonextensible, and cannot be modified in any way.
    
    Specified by:
    
    toXML in class VWInstructionDefinition
    
    Parameters:
    
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWWorkflowDefinition
  - toXPDL
```
public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
```
    Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowCollectionDefinition.writeToFile(String).
    
    Appends an XPDL string representing this instance to the buffer specified.
    Warning: This XPDL string is nonextensible, and cannot be modified in any way.
    
    Parameters:
    
    indentA - A String specifying the initial indentation for this XPDL section.
    
    theBuffer - A StringBuffer that will be appended with the XPDL content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWWorkflowCollectionDefinition
  - validate
```
public void validate(VWSession theSession,
                     java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep)
              throws VWException
```
    Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)
    
    Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.
    
    Specified by:
    
    validate in class VWInstructionDefinition
    
    Parameters:
    
    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.
    
    Throws:
    
    VWException - Thrown if an error occurs during the validation.
  - toString
```
public java.lang.String toString()
```
    Gets the name of this rollback instruction
    
    Specified by:
    
    toString in class VWInstructionDefinition
    
    Returns:
    
    A string representing this rollback instruction.

Methods inherited from class filenet.vw.api.VWInstructionDefinition

Methods inherited from class java.lang.Object

getTimeOut

setTimeOut

getEventNumLoc

setEventNumLoc

getEvents

setEvents

createEvent

toXML

toXPDL

validate

toString