VWMilestoneElement (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWMilestoneElement

All Implemented Interfaces:

IVWtoXML
```
public final class VWMilestoneElement
extends java.lang.Object
implements IVWtoXML
```
Use this class to encapsulate a milestone log record. VWProcess.fetchFilteredWorkflowMilestones creates an object of the VWWorkflowMilestones class, so that you can get VWMilestoneElement items (objects) from it with the next() method.
A VWMilestoneElement is built from a VWLogElement, specifically for a milestone event. It only accesses log element information related to milestone events.

Since:

VWWS4.20

See Also:

VWProcess.fetchFilteredWorkflowMilestones(int, boolean, boolean), VWWorkflowMilestones, VWMilestoneDefinition, VWLogElement

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getInstructionSheetId()` Gets the instruction sheet ID of the instruction sheet where the milestone event occurred.
`java.lang.String`	`getInstructionSheetName()` Gets the instruction sheet name of the instruction sheet where the milestone event occurred.
`int`	`getLevel()` Gets the level of the milestone.
`VWLogElement`	`getLogElement()` Gets the VWLogElement object from which this instance was originally constructed.
`java.lang.String`	`getMessage()` Gets the message logged for this milestone event.
`int`	`getMilestoneId()` Gets the milestone ID of the milestone.
`java.lang.String`	`getName()` Gets the milestone name of the milestone definition for this milestone event.
`int`	`getStepId()` Gets the step ID of the step where the milestone event occurred.
`java.util.Date`	`getTimestamp()` Gets the timestamp of the milestone event, according to the time at which the milestone event was logged.
`java.lang.String`	`toString()` Gets a string version of the milestone, displaying several of its properties: ID, name, level, step, instruction sheet name, timestamp, and message.
`void`	`toXML(java.lang.StringBuffer theBuffer)` Appends an XML string representing this instance to the buffer specified.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getMilestoneId
```
public int getMilestoneId()
```
    Gets the milestone ID of the milestone.
    
    Returns:
    
    An integer value that is the milestone ID of the milestone which caused this event to be logged in the event log.
  - getLevel
```
public int getLevel()
```
    Gets the level of the milestone.
    
    Returns:
    
    An integer value that is the level of the milestone which caused this event to be logged in the event log.
  - getStepId
```
public int getStepId()
```
    Gets the step ID of the step where the milestone event occurred.
    
    Returns:
    
    An integer value that is the step ID of the step where the milestone event occurred.
  - getName
```
public java.lang.String getName()
```
    Gets the milestone name of the milestone definition for this milestone event. If a translation source exists, the authored name is translated.
    
    Returns:
    
    A String containing the translated name of the milestone, if a translation source exists; otherwise the authored name is returned.
  - getInstructionSheetId
```
public int getInstructionSheetId()
```
    Gets the instruction sheet ID of the instruction sheet where the milestone event occurred.
    
    Returns:
    
    An integer value that is the instruction sheet ID of the instruction sheet where the milestone event occurred.
  - getInstructionSheetName
```
public java.lang.String getInstructionSheetName()
```
    Gets the instruction sheet name of the instruction sheet where the milestone event occurred. If a translation source exists, the authored name is translated.
    
    Returns:
    
    A String containing the translated name of the instruction sheet, if a translation source exists; otherwise, the authored name is returned.
  - getTimestamp
```
public java.util.Date getTimestamp()
```
    Gets the timestamp of the milestone event, according to the time at which the milestone event was logged.
    
    Returns:
    
    A date type containing the timestamp of the milestone event.
  - getMessage
```
public java.lang.String getMessage()
```
    Gets the message logged for this milestone event.
    
    Returns:
    
    The message logged for this milestone event. Can be null.
  - getLogElement
```
public VWLogElement getLogElement()
```
    Gets the VWLogElement object from which this instance was originally constructed. If a translation source exists, the authored name of the log element is translated.
    
    Returns:
    
    A VWLogElement object from which this instance was originally constructed. if a translation source exists, the translated log element name is returned; otherwise, the authored log element name is returned.
  - toString
```
public java.lang.String toString()
```
    Gets a string version of the milestone, displaying several of its properties: ID, name, level, step, instruction sheet name, timestamp, and message.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of the milestone.
  - 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.
    
    Specified by:
    
    toXML in interface IVWtoXML
    
    Parameters:
    
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWXMLUtil

Methods inherited from class java.lang.Object

getMilestoneId

getLevel

getStepId

getName

getInstructionSheetId

getInstructionSheetName

getTimestamp

getMessage

getLogElement

toString

toXML