org.pentaho.platform.workitem

Class WorkItemLifecycleEvent

java.lang.Object

org.pentaho.platform.workitem.WorkItemLifecycleEvent

All Implemented Interfaces:

org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

public class WorkItemLifecycleEvent
extends Object
implements org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

This class encapsulates all information pertaining to a "work item" at a specific point in its lifecycle.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkItemLifecycleEvent.DateAdapter An implementation of XmlAdapter that allows us to [de]serialize Dates as longs (milliseconds).

Constructor Summary

Constructors

Constructor and Description
WorkItemLifecycleEvent() Default constructor, needed for serialization purposes.
WorkItemLifecycleEvent(String workItemUid, String workItemDetails, WorkItemLifecyclePhase workItemLifecyclePhase, String lifecycleDetails, Date sourceTimestamp) Creates the WorkItemLifecycleEvent with all the required parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getLifecycleDetails()
String	getSourceHostIp()
String	getSourceHostName()
Date	getSourceTimestamp()
String	getWorkItemDetails()
WorkItemLifecyclePhase	getWorkItemLifecyclePhase()
String	getWorkItemUid()
int	hashCode()
void	setLifecycleDetails(String lifecycleDetails)
void	setSourceHostIp(String sourceHostIp)
void	setSourceHostName(String sourceHostName)
void	setSourceTimestamp(Date sourceTimestamp)
void	setWorkItemDetails(String workItemDetails)
void	setWorkItemLifecyclePhase(WorkItemLifecyclePhase workItemLifecyclePhase)
void	setWorkItemUid(String workItemUid)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkItemLifecycleEvent

public WorkItemLifecycleEvent()

Default constructor, needed for serialization purposes.

WorkItemLifecycleEvent

public WorkItemLifecycleEvent(String workItemUid,
                              String workItemDetails,
                              WorkItemLifecyclePhase workItemLifecyclePhase,
                              String lifecycleDetails,
                              Date sourceTimestamp)

Creates the WorkItemLifecycleEvent with all the required parameters.

Parameters:

workItemUid - a String containing unique identifier for the WorkItemLifecycleEvent

workItemDetails - an String containing details of the WorkItemLifecycleEvent

workItemLifecyclePhase - a WorkItemLifecyclePhase representing the lifecycle event

lifecycleDetails - a String containing any additional details about the lifecycle event, such as pertinent failure messages

sourceTimestamp - a Date representing the time the lifecycle change occurred.

Method Detail

getWorkItemUid

public String getWorkItemUid()

Specified by:

getWorkItemUid in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setWorkItemUid

public void setWorkItemUid(String workItemUid)

getWorkItemDetails

public String getWorkItemDetails()

Specified by:

getWorkItemDetails in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setWorkItemDetails

public void setWorkItemDetails(String workItemDetails)

getWorkItemLifecyclePhase

public WorkItemLifecyclePhase getWorkItemLifecyclePhase()

Specified by:

getWorkItemLifecyclePhase in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setWorkItemLifecyclePhase

public void setWorkItemLifecyclePhase(WorkItemLifecyclePhase workItemLifecyclePhase)

getLifecycleDetails

public String getLifecycleDetails()

Specified by:

getLifecycleDetails in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setLifecycleDetails

public void setLifecycleDetails(String lifecycleDetails)

getSourceTimestamp

public Date getSourceTimestamp()

Specified by:

getSourceTimestamp in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setSourceTimestamp

public void setSourceTimestamp(Date sourceTimestamp)

getSourceHostName

public String getSourceHostName()

Specified by:

getSourceHostName in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setSourceHostName

public void setSourceHostName(String sourceHostName)

getSourceHostIp

public String getSourceHostIp()

Specified by:

getSourceHostIp in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent

setSourceHostIp

public void setSourceHostIp(String sourceHostIp)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object