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.sap.netweaver.bc.rf.util.event
Interface IEvent

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.util_api.jar]
public interface IEvent

Interface describing an event with a type and an arbitrary parameter.

Method Summary
 java.lang.String getCorrelationId()
          Get correlation id of event.
 java.lang.String getDescription()
          Get description of event.
 java.lang.String getDescription(java.util.Locale locale)
          Get localized description of event.
 java.lang.Object getParameter()
          Get arbitrary parameter of event.
 EnumWithDescription getType()
          Get type of event.
 java.lang.String getUniqueId()
          Get unique id of event.
 boolean isLike(IEvent template)
          Compares this event with another event for equality or some kind of "similarity".
 

Method Detail

getUniqueId

public java.lang.String getUniqueId()
Get unique id of event.
Returns:
unique id of event

getCorrelationId

public java.lang.String getCorrelationId()
Get correlation id of event.
Returns:
correlation id of event

getType

public EnumWithDescription getType()
Get type of event.
Returns:
type of event

getParameter

public java.lang.Object getParameter()
Get arbitrary parameter of event.
Returns:
arbitrary parameter of event

getDescription

public java.lang.String getDescription()
Get description of event.
Returns:
description of event

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Get localized description of event.
Parameters:
locale - locale to be used for localization
Returns:
localized description of event

isLike

public boolean isLike(IEvent template)
Compares this event with another event for equality or some kind of "similarity". Normally an event equals another if it is of the same instance and type. There might be implementations that want to match one event type with many others.
Parameters:
template - event to compare against
Returns:
true, if the specified event template is equal to this event, according to the implemented matching rules
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.