Modifier and Type | Class and Description |
---|---|
protected class |
ChannelFactory.ObjectClassEntry |
Modifier and Type | Field and Description |
---|---|
static String |
EMAIL
channel type EMAIL.
|
static String |
FAX
channel type FAX.
|
static String |
NULL_CHANNEL
channel type NULL.
|
static String |
SMS
channel type SMS.
|
static String |
STORE
channel type STORE.
|
Modifier and Type | Method and Description |
---|---|
IChannelList |
createChannelList()
Create an empty
IChannelList . |
IChannel |
getChannel(String id)
Get an
IChannel instance for a specific id. |
IChannelList |
getChannelForType(String type)
Get a list of
IChannel s for a given type. |
IChannelList |
getChannels()
Get a list with all available
IChannel s. |
IChannel |
getFirstChannelForType(String type)
Get the first instance of an
IChannel for a given type. |
static ChannelFactory |
getInstance()
Get a new instance of the factory.
|
static String[] |
getRecipientAdresses(IChannel channel,
IRecipientList recipients)
Utility method to convert an array of recipients to an array of addresses
in a specific channel format.
|
protected HashMap |
loadObjectMap(com.sapportals.config.fwk.IConfigurable[] configurables) |
protected ChannelFactory.ObjectClassEntry |
newObjectListEntry(String id,
Constructor constructor,
Properties properties) |
void |
reconfigure()
Reload the factory's configuration.
|
public static final String EMAIL
public static final String SMS
public static final String FAX
public static final String STORE
public static final String NULL_CHANNEL
protected HashMap loadObjectMap(com.sapportals.config.fwk.IConfigurable[] configurables) throws WcmException
WcmException
protected ChannelFactory.ObjectClassEntry newObjectListEntry(String id, Constructor constructor, Properties properties)
public static ChannelFactory getInstance() throws WcmException
ChannelFactory
.WcmException
- if the factory can not be created.public void reconfigure() throws WcmException
WcmException
- if the factory's configuration can not be reloaded.public IChannel getChannel(String id) throws WcmException
IChannel
instance for a specific id.id
- a String
id of the channel.IChannel
with the channel for the given id,
null
if no channel exists for the given id.WcmException
- if there an error occured while creating
the channel.public IChannelList getChannelForType(String type) throws WcmException
IChannel
s for a given type.type
- a String
type of the channel.IChannelList
with channels for the given type, may
be empty if no channels exists for that type.WcmException
- if there an error occured while creating
the channels.public IChannel getFirstChannelForType(String type) throws WcmException
IChannel
for a given type.type
- a String
type of the channel.IChannel
for the given type, null
if
there is no channel with the given type.WcmException
- if an error occured while creating the
channel.public IChannelList getChannels() throws WcmException
IChannel
s.IChannelList
which may be empty if no channels
exist.WcmException
- if there an error occured while creating
the channel.public static String[] getRecipientAdresses(IChannel channel, IRecipientList recipients) throws WcmException
channel
- an IChannel
which defines the address format.recipients
- an array of IRecipient
s to get the
addresses for.String
s with the addresses.WcmException
- if an error occurred while resolving the
recipients addresses.public IChannelList createChannelList() throws WcmException
IChannelList
.IChannelList
.WcmException
- if the list could not be created.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