org.eclipse.stardust.engine.api.runtime
Interface HistoricalEvent

All Superinterfaces:

java.io.Serializable

public interface HistoricalEvent
extends java.io.Serializable

The HistoricalEvent represents a single event which was recorded during lifetime of an ActivityInstance or ProcessInstance.

Author:

Stephan.Born

Method Summary

java.io.Serializable	getDetails() Getter to retrieve an object which contains more specific information about the event.
java.util.Date	getEventTime() Will return the event time.
HistoricalEventType	getEventType() Will return the event type.
User	getUser() Will return the user which was responsible for the event.

Method Detail

getEventType

HistoricalEventType getEventType()

Will return the event type.

Returns:

The event type.

getEventTime

java.util.Date getEventTime()

Will return the event time.

Returns:

The time the event occurred on.

getDetails

java.io.Serializable getDetails()

Getter to retrieve an object which contains more specific information about the event. The concrete type of this details object depends on the HistoricalEventType:

HistoricalEventType.Delegation: details contained in HistoricalEventDescriptionDelegation instance.

HistoricalEventType.StateChange: details contained in HistoricalEventDescriptionStateChange instance.

HistoricalEventType.Exception: details contained in a String.

HistoricalEventType.Note: details contained in a String.

Returns:

The details for the event.

getUser

User getUser()

Will return the user which was responsible for the event.

Returns:

The user object.