com.tibco.be.custom.channel

Interface Event

All Known Subinterfaces:

EventWithId

All Known Implementing Classes:

DefaultEventImpl

public interface Event

An abstraction of a BE runtime event that the channel API uses. It acts as a bridge to the runtime BE events. Instances of Event are transformed into runtime BE event instances on the inbound side, and instances of BE events are transformed to this interface on the outbound side.

Since:

5.4

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getAllPropertyNames() Gets all the property names in this event.
java.lang.String	getDestinationURI() Gets the destination URI associated with this event
java.lang.String	getEventUri() Gets the eventUri of this event
java.lang.String	getExtId() Gets the unique ID representing this event
byte[]	getPayload() Gets the payload of this event
java.lang.Object	getPropertyValue(java.lang.String name) Gets the value of a property by name.
void	setDestinationURI(java.lang.String destinationURI) Sets the destination URI associated with this event
void	setEventUri(java.lang.String eventUri) Sets the eventUri of this event
void	setExtId(java.lang.String extId) Sets the unique ID representing this event
void	setPayload(byte[] payload) Sets the payload of this event
void	setProperty(java.lang.String name, java.lang.Object value) Sets the value of a property by name.

Method Detail

getExtId

java.lang.String getExtId()

Gets the unique ID representing this event

Returns:

extId unique id

Since:

5.4

setExtId

void setExtId(java.lang.String extId)

Sets the unique ID representing this event

Parameters:

extId - unique id

Since:

5.4

getDestinationURI

java.lang.String getDestinationURI()

Gets the destination URI associated with this event

Returns:

destination URI of the destination associated with this event

Since:

5.4

setDestinationURI

void setDestinationURI(java.lang.String destinationURI)

Sets the destination URI associated with this event

Parameters:

destinationURI - the URI of the destination

Since:

5.4

getPayload

byte[] getPayload()

Gets the payload of this event

Returns:

payload a byte array representing the payload

Since:

5.4

setPayload

void setPayload(byte[] payload)

Sets the payload of this event

Parameters:

payload - a byte array representing the payload

Since:

5.4

getEventUri

java.lang.String getEventUri()

Gets the eventUri of this event

Returns:

eventUri the eventUri associated with this event

Since:

5.4

setEventUri

void setEventUri(java.lang.String eventUri)

Sets the eventUri of this event

Parameters:

eventUri - the eventUri to be set to this event

Since:

5.4

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)

Sets the value of a property by name.

Parameters:

name - name of the event property.

value - the Object value to be set. The type of value must be consistent with the type defined in the model.

Since:

5.4

getPropertyValue

java.lang.Object getPropertyValue(java.lang.String name)

Gets the value of a property by name.

Parameters:

name - name of the event property.

Returns:

the value of that property.

Since:

5.4

getAllPropertyNames

java.util.Collection getAllPropertyNames()

Gets all the property names in this event.

Returns:

all the Property names in Collection<String>

Since:

5.4