Process Class Relationships

filenet.vw.api
Class VWMilestoneDefinition

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

public final class VWMilestoneDefinition
extends java.lang.Object
implements java.io.Serializable

Use this class to access the name, message, level, and other properties of a milestone used in a workflow process.

Since:
VWWS3.10
See Also:
VWStepDefinition, VWWorkflowDefinition, Serialized Form

Method Summary
 int getLevel()
          Gets the level of this milestone.
 java.lang.String getMessage()
          Gets the message of this milestone.
 java.lang.String getName()
          Gets the name of this milestone.
 void setLevel(int theLevel)
          Sets the level for the milestone.
 void setMessage(java.lang.String theMessage)
          Sets the message for the milestone. The message expression will be evaluated and the result will be logged when the milestone is reached at runtime.
 void setName(java.lang.String theName)
          Sets the name for the milestone.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWMilestoneDefinition object to the buffer specified by the input parameter.
 void validate(VWSession theSession, java.util.Vector EDefVector)
          Validate this VWMilestoneDefinition object by testing that the message is an expression that conforms to workflow server grammar.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Gets the name of this milestone.
Returns:
The name of the milestone.

setName

public void setName(java.lang.String theName)
             throws VWException
Sets the name for the milestone.
Parameters:
theName - The string value of the new name of the milestone.
Throws:
VWException - Thrown if an error occurs.
VWException - This method throws an exception if one of the following conditions exist:

  • The milestone name is null or has a length of zero (0).
  • The milestone name is the same as an existing milestone name.

getMessage

public java.lang.String getMessage()
Gets the message of this milestone.
Returns:
The message of the milestone.

setMessage

public void setMessage(java.lang.String theMessage)
                throws VWException
Sets the message for the milestone. The message expression will be evaluated and the result will be logged when the milestone is reached at runtime.
Parameters:
theMessage - An expression that must conform to workflow server grammar. For information on workflow server grammar refer to the eProcess online help, the section on reference>expressions. Use validate(VWSession, Vector) to test message grammar.
Throws:
VWException -  
See Also:
validate(VWSession, Vector)

getLevel

public int getLevel()
Gets the level of this milestone.
Returns:
An integer indicating the level of the milestone.
See Also:
setLevel(int)

setLevel

public void setLevel(int theLevel)
              throws VWException
Sets the level for the milestone.
Parameters:
theLevel - The integer value of the new level of the milestone. This should be a value between 1 and 99, inclusive.
Throws:
VWException - Thrown if an error occurs.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWMilestoneDefinition object to the buffer specified by the input parameter.
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)
              throws VWException
Validate this VWMilestoneDefinition object by testing that the message is an expression that conforms to workflow server grammar. For information on workflow server grammar refer to the eProcess online help, the section on reference>expressions.
Parameters:
theSession - The current session object
EDefVector - a Vector that will hold any new VWValidationErrors found during this call
Note:
The Vector may already contain some validation errors from previous validation calls for other objects
Returns:
void. Note:
The EDefVector will be updated to contain any validation errors found during this call.
Throws:
VWException - Thrown if an error occurs during the validation, for example if there is no containing workflow definition or runtime milestone definition.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.