fuego.papi
Class InstanceEvent

java.lang.Object
  fuego.papi.InstanceEvent

All Implemented Interfaces:

Serializable, Comparable

public class InstanceEvent
extends Object
implements Serializable, Comparable

Contains a process-instance event basic information.

See Also:

Serialized Form

Field Summary

Time	activationTime
String	activity
String[]	bussinesVariablesIds
Object[]	bussinesVariablesValues
int	category
String	eventData
static String	EXCEPTION
int	id
static String	INSTANCE_ACTION
static String	INSTANCE_DUE
int	instanceIn
String	participantId
int	participantIn
String	processId
int	processIn
Time	receiveTime
static String	TASK_EXECUTION_RESULT
static String	TASK_NAME
static String	TASK_NUMBER
static String	TASK_STATE
int	threadIn
Time	timeStamp
static String	TRANSITION_FROM
static String	TRANSITION_RULE_ID
static String	TRANSITION_TO
static String	TRANSITION_TYPE
int	type

Constructor Summary

InstanceEvent()

Method Summary

int	compareTo(Object compareObject) Implementation of the method inherited from the interface Comparable.
Time	getActivationTime() Returns the time when the instance which generate this event started to execute the activity.
String	getActivity() Returns the activity where the event was generated.
String[]	getBussinesVariablesIds() Returns all bussiness variables identification stored in the event.
Object[]	getBussinesVariablesValues() Returns all bussiness variables values stored in the event.
int	getCategory() Returns the category of the event.
String	getDescription(Locale locale) Gets the description of the event for the given Locale
String	getEventData() Returns the data stored in the event.
String	getEventDataValue(String key)
int	getId() Returns the id of the event.
String	getInstanceId() Returns the id of the instance where the event was generated.
int	getInstanceIn() Returns the instance identification number where the event was generated.
String	getParticipantId() Returns the participant identification which generated the event.
int	getParticipantIn() Returns the participant identification number which generated the event.
String	getProcessId() Returns the id of the process where the event was generated.
int	getProcessIn() Deprecated. 'In' is not a valid identifier in all environments. Use process id instead.
Time	getReceiveTime() Returns the time when the instance arrived to the activity where the event was generated.
int	getThreadIn() Returns the thread identification number where the event was generated.
Time	getTimeStamp() Returns the time when the event was generated.
int	getType() Returns the type of the event.
String	toString() Gets the representation of the instance as a String

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

activationTime

public Time activationTime

activity

public String activity

bussinesVariablesIds

public String[] bussinesVariablesIds

bussinesVariablesValues

public Object[] bussinesVariablesValues

category

public int category

eventData

public String eventData

id

public int id

instanceIn

public int instanceIn

participantId

public String participantId

participantIn

public int participantIn

processId

public String processId

processIn

public int processIn

receiveTime

public Time receiveTime

threadIn

public int threadIn

timeStamp

public Time timeStamp

type

public int type

TASK_NUMBER

@NonNls
public static final String TASK_NUMBER

See Also:

Constant Field Values

TASK_NAME

@NonNls
public static final String TASK_NAME

See Also:

Constant Field Values

TASK_STATE

@NonNls
public static final String TASK_STATE

See Also:

Constant Field Values

TASK_EXECUTION_RESULT

@NonNls
public static final String TASK_EXECUTION_RESULT

See Also:

Constant Field Values

INSTANCE_ACTION

@NonNls
public static final String INSTANCE_ACTION

See Also:

Constant Field Values

INSTANCE_DUE

@NonNls
public static final String INSTANCE_DUE

See Also:

Constant Field Values

TRANSITION_FROM

@NonNls
public static final String TRANSITION_FROM

See Also:

Constant Field Values

TRANSITION_TO

@NonNls
public static final String TRANSITION_TO

See Also:

Constant Field Values

TRANSITION_TYPE

@NonNls
public static final String TRANSITION_TYPE

See Also:

Constant Field Values

TRANSITION_RULE_ID

@NonNls
public static final String TRANSITION_RULE_ID

See Also:

Constant Field Values

EXCEPTION

@NonNls
public static final String EXCEPTION

See Also:

Constant Field Values

Constructor Detail

InstanceEvent

public InstanceEvent()

Method Detail

getActivationTime

public Time getActivationTime()

Returns the time when the instance which generate this event started to execute the activity.

Returns:

Time when the activity started to execute.

getActivity

public String getActivity()

Returns the activity where the event was generated.

Returns:

The activity name where the event was generated.

getBussinesVariablesIds

public String[] getBussinesVariablesIds()

Returns all bussiness variables identification stored in the event.

Returns:

An array with all bussines variables identification.

getBussinesVariablesValues

public Object[] getBussinesVariablesValues()

Returns all bussiness variables values stored in the event.

Returns:

An array with all bussines variables values.

getCategory

public int getCategory()

Returns the category of the event.

Returns:

The category of the event.

getEventData

public String getEventData()

Returns the data stored in the event.

Returns:

The data of the event.

See Also:

getEventDataValue(String)

getId

public int getId()

Returns the id of the event. The id is generating in ascending manner.

Returns:

The id of the event.

getInstanceIn

public int getInstanceIn()

Returns the instance identification number where the event was generated.

Returns:

The instance identification number.

getParticipantId

public String getParticipantId()

Returns the participant identification which generated the event.

Returns:

The participant identification.

getParticipantIn

public int getParticipantIn()

Returns the participant identification number which generated the event.

Returns:

The participant identification number.

getProcessIn

@Deprecated
public int getProcessIn()

Deprecated. 'In' is not a valid identifier in all environments. Use process id instead.

Returns the process identification number where the event was generated.

Returns:

The process identification number.

getReceiveTime

public Time getReceiveTime()

Returns the time when the instance arrived to the activity where the event was generated.

Returns:

Time when the instance arrived to the activity.

getThreadIn

public int getThreadIn()

Returns the thread identification number where the event was generated.

Returns:

The thread identification number.

getTimeStamp

public Time getTimeStamp()

Returns the time when the event was generated.

Returns:

Time when the the event was generated.

getType

public int getType()

Returns the type of the event.

Returns:

The event type.

getProcessId

public String getProcessId()

Returns the id of the process where the event was generated. Will return null if retrieved from an ALBPM Engine with version prior to the mentioned in since.

Returns:

String The process id.

Since:

ALBPM 6.1

getInstanceId

public String getInstanceId()

Returns the id of the instance where the event was generated. Will return null if retrieved from an ALBPM Engine with version prior to the mentioned in since.

Returns:

String The instance id.

Since:

ALBPM 6.1

getDescription

public final String getDescription(Locale locale)

Gets the description of the event for the given Locale

toString

@NonNls
public final String toString()

Gets the representation of the instance as a String

Overrides:

toString in class Object

getEventDataValue

public String getEventDataValue(String key)

compareTo

public int compareTo(Object compareObject)

Implementation of the method inherited from the interface Comparable.

Specified by:

compareTo in interface Comparable