|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWMilestoneElement
public final class VWMilestoneElement
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.
VWProcess.fetchFilteredWorkflowMilestones(int, boolean, boolean)
,
VWWorkflowMilestones
,
VWMilestoneDefinition
,
VWLogElement
Method Summary | |
---|---|
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 |
---|
public int getMilestoneId()
public int getLevel()
public int getStepId()
public java.lang.String getName()
public int getInstructionSheetId()
public java.lang.String getInstructionSheetName()
public java.util.Date getTimestamp()
public java.lang.String getMessage()
public VWLogElement getLogElement()
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |