|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWEventDefinition
public final class VWEventDefinition
The VWEventDefinition class encapsulates methods and data that define events. Events are used in the Wait For Event instructions (class VWWFEInstruction) of a compound step definition.
When an event is evoked, the system compares the event's expression value against the F_Tag field of the current work object, using the event's comparison operator. If this comparison is true, the event occurs.
When an event occurs, it can cause the current work object
to move to a specified instruction sheet (map)
(method setCallISName(String)
). An event can also cause a series of
value assignments to occur (method setAssignments(String[][])
).
VWCompoundStepDefinition
,
VWInstructionDefinition
,
VWWFEInstruction
,
Serialized FormField Summary | |
---|---|
static int |
LVALUE
Value of 0: this constant can be used to subscript into the left-hand side values of an event assignment array. |
static int |
RVALUE
Value of 1: this constant can be used to subscript into right-hand side values of an event assignment array. |
Method 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. |
java.lang.String[][] |
getAssignments()
Gets the assignments property value for the event. |
java.lang.String |
getCallISName()
Gets the name of the instruction sheet (map) that is called when this event occurs. |
java.lang.String |
getComparisonOperator()
Gets this event's comparison operator. |
VWSession |
getSession()
Get the session associated with this event definition. |
java.lang.String |
getValue()
Gets this event's value expression. |
java.lang.String |
getWorkClassName()
Gets the value of this event's work class name property. |
void |
setAssignments(java.lang.String[][] theAssignments)
Sets the assignments property value for the event. |
void |
setCallISName(java.lang.String theCallISName)
Changes the value of this event's instruction sheet call property. |
void |
setComparisonOperator(java.lang.String theOperator)
Changes the value of this event's comparison operator. |
void |
setValue(java.lang.String theValue)
Changes the value of this event's value expression property. |
void |
setWorkClassName(java.lang.String theWorkClassName)
Changes the value of this event's work class name property, which is the non-null name of the work class which contains this event. |
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,
VWWorkflowDefinition theWorkflow,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep,
int instId,
int eventId)
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, toString, wait, wait, wait |
Field Detail |
---|
public static final int LVALUE
public static final int RVALUE
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 getWorkClassName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setWorkClassName
public void setWorkClassName(java.lang.String theWorkClassName) throws VWException
theWorkClassName
- The new value of this event's
work class name property.
VWException
- Thrown if an error occurs,
for example if the parameter is set to null.setComparisonOperator(String)
,
getWorkClassName()
,
setValue(String)
public java.lang.String getValue()
setComparisonOperator(String)
,
setValue(String)
public void setValue(java.lang.String theValue) throws VWException
theValue
- This event's value expression; it cannot be null.
VWException
- Thrown if an error occurs, for example if
the passed-in parameter theValue is null.getValue()
,
setComparisonOperator(String)
,
VWWorkflowSignature.getFTagExpression()
public java.lang.String getCallISName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setCallISName
public void setCallISName(java.lang.String theCallISName) throws VWException
theCallISName
- The new name of the instruction sheet (map)
which will be called when this event occurs. Since calling an
instruction sheet when an event occurs is optional, a null value is valid.
VWException
getCallISName
public java.lang.String getComparisonOperator()
setComparisonOperator(String)
,
getValue()
,
setValue(String)
public void setComparisonOperator(java.lang.String theOperator) throws VWException
theOperator
- The new value of this event's comparison
operator.
The operator specified will be used to compare this event's value
property against the current value of the F_Tag field of the work
class containing this event. If this expression is true, the system
recognizes that this event has occurred.The operator value must be one among the following: "=", ">", "<", "<>", "<=", or ">=".
Note: The operator cannot be null.
VWException
- Thrown if an error occurs, for example if
the passed-in operator argument is null.getComparisonOperator()
,
getValue()
,
setValue(String)
public java.lang.String[][] getAssignments()
LVALUE
,
RVALUE
,
setAssignments(String[][])
public void setAssignments(java.lang.String[][] theAssignments) throws VWException
theAssignments
- A two-dimensional array of Strings that
contains pairs of left values and right values of assignment
operations.
Array Dimensionality. The grouping in pairs is accomplished by making the size of the second dimension of the array two, corresponding to the two items in a pair. The number of pairs is indicated by the size of the first dimension of the array. This dimensionality effectively organizes the array into two "columns".
Column organization. The first "column" (second subscript value=0) holds left-side values of the assignment operations, represented as string expressions. Left-side values are typically field names, often subscripted. Left-side values cannot be null.
The second "column" (second subscript value=1) holds the right-side values of the assignment. Right-side values can be any non-null, valid string expression recognized by the workflow server. Some examples of right-side expressions include the string "hello" or the number 75, as literal values. Other valid right-side expressions include field names, arithmetic and boolean expressions, and function calls.
Note: This parameter may be null, to signify that no assignments are made when the event occurs.
VWException
- Thrown if the theAssignments array is not
properly dimensioned, or if any individual array elements are null.LVALUE
,
RVALUE
,
getAssignments()
public 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 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, VWWorkflowDefinition theWorkflow, java.util.Vector EDefVector, VWCompoundStepDefinition myStep, int instId, int eventId) 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.theWorkflow
- The VWWorkflowDefinition object for the containing workflow.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
- The VWCompoundStepDefinition object containing this event.instId
- An integer identifying the instruction ID for the VWWFEInstruction object that contains this event.eventId
- An integer identifying the event ID of this event (its index into the array of events that
belongs to the containing VWWFEInstruction).
VWException
- Thrown if an error occurs during the validation.VWCompoundStepDefinition
,
VWValidationError
,
VWWFEInstruction
public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |