com.sapportals.wcm.util.events

Interface IEventMapper

All Known Subinterfaces:

IResourceEventMapper

All Known Implementing Classes:

AbstractEventMapper, AbstractResourceEventMapper

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.

Copyright (c) SAP AG 2001-2002

Method Summary

String	getDescription() Get the mapper's displayable name.
String	getDescription(Locale locale) Get the mapper's displayable name for a specific locale.
IEventList	getEvents(IEventBroker broker) Get a list of available mapped events for a given broker.
String	getID() Get the mapper's unique system id.
IEvent	map(IEvent event) Map an IEvent to another IEvent .

Method Detail

getID

String getID()

Get the mapper's unique system id.

Returns:

a String with the mapper's system id.

getDescription

String getDescription()

Get the mapper's displayable name.

Returns:

a String with the mapper's displayable name.

getDescription

String getDescription(Locale locale)

Get the mapper's displayable name for a specific locale.

Parameters:

locale - a Locale defining the language to get the name for.

Returns:

a String with the mapper's displayable name in the given locale.

map

IEvent map(IEvent event)

Map an IEvent to another IEvent .
Note : It's a good idea, to pass the original (unmapped) event as the mapped event's parameter.

Parameters:

event - the IEvent to map.

Returns:

the mapped IEvent corresponding to the given event or null , if the event is to be ignored (not mapped).

getEvents

IEventList getEvents(IEventBroker broker)

Get a list of available mapped events for a given broker.

Parameters:

broker - the IEventBroker to get the supported events for.

Returns:

the IEventList with all available mapped events.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM