org.mule.runtime.api.message

Interface MuleEvent

All Superinterfaces:

Serializable

public interface MuleEvent
extends Serializable

Represents any data event occurring in the Mule environment. All data sent or received within the mule environment will be passed between components as an MuleEvent.

Since:

1.0

See Also:

MuleMessage

Method Summary

Modifier and Type	Method and Description
<T> T	getFlowVariable(String key) Returns the flow variable registered under the given kye
String	getId() Every event in the system is assigned a universally unique id (UUID).
MuleMessage	getMessage() Returns the message payload for this event
void	removeFlowVariable(String key) Removes the flow variable registered under the given key
void	setFlowVariable(String key, Object value) Sets a flow variable value with a default data type
void	setFlowVariable(String key, Object value, DataType dataType) Sets a flow variable value with a given data type

Method Detail

getId

String getId()

Every event in the system is assigned a universally unique id (UUID).

Returns:

the unique identifier for the event

getFlowVariable

<T> T getFlowVariable(String key)

Returns the flow variable registered under the given kye

Type Parameters:

T - the value's generic type

Parameters:

key - the name or key of the variable. This must be non-null.

Returns:

the variable's value

setFlowVariable

void setFlowVariable(String key,
                     Object value)

Sets a flow variable value with a default data type

Parameters:

key - the name or key of the variable. This must be non-null.

value - value for the variable

setFlowVariable

void setFlowVariable(String key,
                     Object value,
                     DataType dataType)

Sets a flow variable value with a given data type

Parameters:

key - the name or key of the variable. This must be non-null.

value - value for the variable

dataType - value's dataType. Not null.

removeFlowVariable

void removeFlowVariable(String key)

Removes the flow variable registered under the given key

Parameters:

key - the name or key of the variable. This must be non-null.

getMessage

MuleMessage getMessage()

Returns the message payload for this event

Returns:

the event's MuleMessage