Package org.activiti.engine.delegate.event

Interface ActivitiMessageEvent

All Superinterfaces:

ActivitiActivityEvent, ActivitiEvent

All Known Implementing Classes:

ActivitiMessageEventImpl

public interface ActivitiMessageEvent
extends ActivitiActivityEvent

An ActivitiEvent related to an message being sent to an activity.

Method Summary

Modifier and Type	Method	Description
String	getMessageBusinessKey()
String	getMessageCorrelationKey()
Object	getMessageData()
String	getMessageName()

Methods inherited from interface org.activiti.engine.delegate.event.ActivitiActivityEvent

getActivityId, getActivityName, getActivityType, getBehaviorClass

Methods inherited from interface org.activiti.engine.delegate.event.ActivitiEvent

getExecutionId, getProcessDefinitionId, getProcessInstanceId, getType

Method Details

getMessageName

String getMessageName()

Returns:

the name of the message.

getMessageCorrelationKey

String getMessageCorrelationKey()

Returns:

the correlation key that was passed when sending the message. Returns null, if no correlation key was passed.

getMessageData

Object getMessageData()

Returns:

the payload that was passed when sending the message. Returns null, if no payload was passed.

getMessageBusinessKey

String getMessageBusinessKey()

Returns:

the business key from process instance sending the message. Returns null, if no business key was passed.