Process Class Relationships

filenet.vw.api
Class VWWFEInstruction

java.lang.Object
  |
  +--filenet.vw.api.VWInstructionDefinition
        |
        +--filenet.vw.api.VWWFEInstruction
All Implemented Interfaces:
java.io.Serializable

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
 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

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 VWWFEInstruction instance.
Returns:
An array of all VWEventDefinition objects contained in this VWCompoundStepDefinition object. 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 there are no events defined in the WFEInstruction, the method returns null.
Throws:
VWException - Thrown if it cannot get the events.

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
Appends an XML string that represents this VWWFEInstruction instance to the buffer specified by the input parameter.

Warning: This XML string is non-extensible, and cannot be modified in any way.

Overrides:
toXML in class VWInstructionDefinition
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep)
              throws VWException
Validate this VWWFEInstruction object.
Overrides:
validate in class VWInstructionDefinition
Parameters:
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 VWCompoundStepDefinition
Returns:
There is no return value, but the EDefVector is updated to contain the validation errors this method detects.
Throws:
VWException -  

toString

public java.lang.String toString()
Gets the name of this rollback instruction
Overrides:
toString in class VWInstructionDefinition
Returns:
A string representing this rollback instruction.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.