org.pentaho.platform.api.workitem

Interface IWorkItemLifecycleEvent

public interface IWorkItemLifecycleEvent

Encapsulates all information pertaining to a "work item" at a specific point in its lifecycle.

Method Summary

Modifier and Type	Method and Description
String	getLifecycleDetails() Returns details related to the current IWorkItemLifecyclePhase
String	getSourceHostIp() Returns the ip of the host where the event originated.
String	getSourceHostName() Returns the hostname of the host where the event originated.
Date	getSourceTimestamp() Returns the Date when the event occured.
String	getWorkItemDetails() Returns the work item details.
IWorkItemLifecyclePhase	getWorkItemLifecyclePhase() Returns the current IWorkItemLifecyclePhase for the work item.
String	getWorkItemUid() Returns the unique id of a work item.

Method Detail

getWorkItemUid

String getWorkItemUid()

Returns the unique id of a work item.

Returns:

the unique id of a work item

getWorkItemDetails

String getWorkItemDetails()

Returns the work item details.

Returns:

the work item details

getWorkItemLifecyclePhase

IWorkItemLifecyclePhase getWorkItemLifecyclePhase()

Returns the current IWorkItemLifecyclePhase for the work item.

Returns:

the current IWorkItemLifecyclePhase for the work item.

getLifecycleDetails

String getLifecycleDetails()

Returns details related to the current IWorkItemLifecyclePhase

Returns:

details related to the current IWorkItemLifecyclePhase

getSourceTimestamp

Date getSourceTimestamp()

Returns the Date when the event occured.

Returns:

the Date when the event occured.

getSourceHostName

String getSourceHostName()

Returns the hostname of the host where the event originated.

Returns:

the hostname of the host where the event originated.

getSourceHostIp

String getSourceHostIp()

Returns the ip of the host where the event originated.

Returns:

the ip of the host where the event originated.