java.lang.Object | +--com.ibm.commerce.messaging.notification.NotificationConfigurationHelper
This is the interface we expose to clients. The methods are all static.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM Copyright field |
Method Summary | |
---|---|
static java.lang.Long |
addTransportOverride(java.lang.Long notificationId,
TransportOverride transportOverride) Add a transport override to a notification object. |
static java.lang.Long |
createNotificationObject(
TransportOverride[] transportOverrides) Creates a new notification object. |
static void |
deleteNotificationObject(java.lang.Long notificationId) Deletes a notification object. |
static void |
deleteTransportOverride(java.lang.Long notificationId,
java.lang.String transportName, java.lang.String msgTypeName) Delete a transport override entry from a notification object. |
static
TypedProperty |
getAttributesForTransport(java.lang.String transportName) Returns the over-rideable attributes for a particular transport. |
static
Notification |
getNotificationObject(java.lang.Long notificationId) Gets a notification object by id. |
static java.lang.String[] |
getTransportsForMsgTypeName(java.lang.String msgTypeName,
java.lang.Integer storeId) Returns the transports supported for this message type. |
static void |
replaceTransportOverride(java.lang.Long notificationId,
TransportOverride transportOverride) Replaces a transport override for a notification object. |
static void |
updateTransportOverride(java.lang.Long notificationId,
TransportOverride transportOverride) Updates a transport override for a notification object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Method Detail |
---|
public static java.lang.String[] getTransportsForMsgTypeName(java.lang.String msgTypeName, java.lang.Integer storeId) throws ECException
msgTypeName
- the name of the msgtype; not nullstoreId
- the id of the store; not nullECException
public static TypedProperty getAttributesForTransport(java.lang.String transportName) throws ECException
transportName
- the name of the transportECException
public static java.lang.Long createNotificationObject(TransportOverride[] transportOverrides) throws ECException
ECException
public static Notification getNotificationObject(java.lang.Long notificationId) throws ECException
notificationId
- notification identifier; not nullECException
public static void deleteNotificationObject(java.lang.Long notificationId) throws ECException
notificationId
- the notification identifier; if null then
method no-opsECException
public static java.lang.Long addTransportOverride(java.lang.Long notificationId, TransportOverride transportOverride) throws ECException
notificationId
- the notification id; may be null; if not
null, then record with notificationId, msgTypeId, transportId must not exist
already.transportOverride
- the details about the transport to
override; not null; transportName must be definedECException
public static void deleteTransportOverride(java.lang.Long notificationId, java.lang.String transportName, java.lang.String msgTypeName) throws ECException
notificationId
- the notification idtransportName
- the transport namemsgTypeName
- the msgTypeNameECException
public static void updateTransportOverride(java.lang.Long notificationId, TransportOverride transportOverride) throws ECException
notificationId
- the notification id; not nulltransportOverride
- the transport override details; not null;
transportid not null; attributes not nullECException
public static void replaceTransportOverride(java.lang.Long notificationId, TransportOverride transportOverride) throws ECException
notificationId
- the notification idtransportOverride
- the transport override detailsECException