Process API

filenet.vw.api
Class VWMilestoneDefinition

java.lang.Object
  extended by filenet.vw.api.VWMilestoneDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

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

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
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.Object clone()
          Creates a clone of this instance.
 boolean equals(java.lang.Object obj)
          Compares the specified object with this item for equality.
 int getLevel()
          Gets the level for 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.
 void setName(java.lang.String theName)
          Sets the name for the milestone.
 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 that represents this instance to the buffer specified.
 void validate(VWSession theSession, java.util.Vector EDefVector)
          Validates this instance, appending any validation errors found to the specified Vector object.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


getName

public java.lang.String getName()
Gets the name of this milestone. If a translation source exists, the authored name is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String containing the translated name of this milestone, if a translation source exists; otherwise the authored name is returned.

setName

public void setName(java.lang.String theName)
             throws VWException
Sets the name for the milestone.

Parameters:
theName - A String containing the name to use for the milestone.
Throws:
VWException - Thrown under the following conditions:
  • The milestone name is null or has a length of zero.
  • 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 is evaluated and the result logged when the milestone is reached at runtime.

Parameters:
theMessage - An expression that conforms to workflow server grammar. See validate method to test message grammar.
Throws:
VWException
See Also:
validate(filenet.vw.api.VWSession, java.util.Vector)

getLevel

public int getLevel()
Gets the level for 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 specified level is invalid.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

toXPDL

public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
Appends an XPDL string that represents 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:
VWXMLUtil

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
Validates this instance, appending any validation errors found to the specified Vector object.

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.

Throws:
VWException - Thrown if an error occurs during the validation; for example, if there is no containing workflow definition or runtime milestone definition.

clone

public java.lang.Object clone()
Creates a clone of this instance.

Overrides:
clone in class java.lang.Object
Returns:
An Object that is a clone of this instance.

equals

public boolean equals(java.lang.Object obj)
Compares the specified object with this item for equality.

Overrides:
equals in class java.lang.Object

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.