public abstract class AbstractEventMapper extends Object implements IEventMapper
Copyright (c) SAP AG 2001-2002
IEventMapper
Modifier and Type | Field and Description |
---|---|
protected static String |
CONFIG_NAME_TAG |
protected String |
m_ID
The system id for this mapper.
|
protected Properties |
m_Properties
The properties for this mapper.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractEventMapper(String id,
Properties properties)
Create a mapper with a specific id from the given properties.
|
Modifier and Type | Method and Description |
---|---|
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.
|
abstract IEvent |
map(IEvent event)
Map an
IEvent to another IEvent . |
protected static final String CONFIG_NAME_TAG
protected String m_ID
protected Properties m_Properties
protected AbstractEventMapper(String id, Properties properties) throws WcmException
id
- TBD: Description of the incoming method parameterproperties
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationpublic String getID()
IEventMapper
getID
in interface IEventMapper
String
with the mapper's system id.public String getDescription()
IEventMapper
getDescription
in interface IEventMapper
String
with the mapper's displayable name.public String getDescription(Locale locale)
IEventMapper
getDescription
in interface IEventMapper
locale
- a Locale
defining the language to get the name
for.String
with the mapper's displayable name in the
given locale.public abstract IEvent map(IEvent event)
IEventMapper
IEvent
to another IEvent
.map
in interface IEventMapper
event
- the IEvent
to map.IEvent
corresponding to the given event or
null
, if the event is to be ignored (not mapped).public IEventList getEvents(IEventBroker broker)
IEventMapper
getEvents
in interface IEventMapper
broker
- the IEventBroker
to get the supported events
for.IEventList
with all available mapped events.Access Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice