|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWMilestoneDefinition
Use this class to access the name, message, level, and other properties of a milestone used in a workflow process.
VWStepDefinition
,
VWWorkflowDefinition
, Serialized FormMethod 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 |
public java.lang.String getName()
public void setName(java.lang.String theName) throws VWException
theName
- The string value of the new name of the
milestone.VWException
- Thrown if an error occurs.VWException
- This method throws an
exception if one of the following conditions exist:
public java.lang.String getMessage()
public void setMessage(java.lang.String theMessage) throws VWException
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.VWException
- validate(VWSession, Vector)
public int getLevel()
setLevel(int)
public void setLevel(int theLevel) throws VWException
theLevel
- The integer value of the new level of the
milestone. This should be a value between 1 and 99, inclusive.VWException
- Thrown if an error occurs.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
theSession
- The current session objectEDefVector
- a Vector that will hold any new
VWValidationErrors found during this call 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 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |