Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.util.events
Interface IEventMapper

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]
All Known Subinterfaces:
IResourceEventMapper
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.

Copyright (c) SAP AG 2001-2002

Method Summary
 java.lang.String getDescription()
          Get the mapper's displayable name.
 java.lang.String getDescription(java.util.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.
 java.lang.String getID()
          Get the mapper's unique system id.
 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.
 

Method Detail

getID

public java.lang.String getID()
Get the mapper's unique system id.
Returns:
a String with the mapper's system id.

getDescription

public java.lang.String getDescription()
Get the mapper's displayable name.
Returns:
a String with the mapper's displayable name.

getDescription

public java.lang.String getDescription(java.util.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

public 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

public 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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.