com.sap.netweaver.bc.rf.util.event

Interface IEventMapper

All Known Implementing Classes:

AbstractEventMapper

public interface IEventMapper

An event mapper maps events to other events. This mapping takes place inside the event broker for receivers that have registered an event mapper. It moves the need to transform events from one kind to another from the event receiver to the broker, but it is more a hack than anything else, because the mapper is totally specific and will be used only in conjunction with the registered receiver.

Method Summary

String	getDescription() Get the mapper's displayable name.
String	getDescription(Locale locale) Get the mapper's localized displayable name.
IEventList	getEvents(IEventBroker broker) Returns a list of mapped event templates for all possible events this mapper can send.
String	getID() Get the mapper's unique system id.
IEvent	map(IEvent event) Map or transform an event prior to sending it to the receiver from one kind to another which then is sent to the receiver.

Method Detail

getID

public String getID()

Get the mapper's unique system id.

Returns:

mapper's unique system id

getDescription

public String getDescription()

Get the mapper's displayable name.

Returns:

mapper's displayable name

getDescription

public String getDescription(Locale locale)

Get the mapper's localized displayable name.

Parameters:

locale - locale

Returns:

mapper's localized displayable name

map

public IEvent map(IEvent event)

Map or transform an event prior to sending it to the receiver from one kind to another which then is sent to the receiver. It might be a good idea to put the orginal event in the user defined parameter of the new mapped and sent event.

Parameters:

event - event to be mapped

Returns:

mapped event

getEvents

public IEventList getEvents(IEventBroker broker)

Returns a list of mapped event templates for all possible events this mapper can send. The event instances contained in the list are "templates", that means the event parameter is not relevant. An implementation of this method should call the broker and ask it to call all its senders to get the list of all possible event templates which can possibly be handed over to a mapper/receiver. Then the mapper should check, which of these event templates are supported and can be mapped and should return these mapped event templates in a list.

Parameters:

broker - broker to be asked for all possible events of all of its senders

Returns:

list of event templates for all possible events this mapper can return in conjunction with the broker