Interface Notification
-
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface Notification
This interface defines a set of methods that may be used to obtain information about a notification to be delivered by a notification manager.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDestinationID()
Retrieve the notification destination ID.java.util.List<NotificationChange>
getNotificationChanges()
Retrieve the list of changes associated with the notification.int
getNumPreviousDeliveryAttempts()
Retrieve the number of previous delivery attempts for this notification.java.util.Date
getTimeOfFirstDeliveryAttempt()
Retrieve the time at which the first delivery attempt was made, ornull
if there have been no previous delivery attempts.java.util.Date
getTimeOfLastDeliveryAttempt()
Retrieve the time at which the last delivery attempt was made, ornull
if there have been no previous delivery attempts.
-
-
-
Method Detail
-
getDestinationID
java.lang.String getDestinationID()
Retrieve the notification destination ID.- Returns:
- The notification destination ID.
-
getNotificationChanges
java.util.List<NotificationChange> getNotificationChanges()
Retrieve the list of changes associated with the notification. A notification can include more than one change when the changes are part of an external transaction (e.g. a multi-update extended operation), unless the notification manager is configured to treat the changes individually.- Returns:
- The list of changes associated with the notification. The returned list may not be modified.
-
getNumPreviousDeliveryAttempts
int getNumPreviousDeliveryAttempts()
Retrieve the number of previous delivery attempts for this notification.- Returns:
- The number of previous delivery attempts for this notification.
-
getTimeOfFirstDeliveryAttempt
java.util.Date getTimeOfFirstDeliveryAttempt()
Retrieve the time at which the first delivery attempt was made, ornull
if there have been no previous delivery attempts.- Returns:
- The time at which the first delivery attempt was made, or
null
if there have been no previous delivery attempts.
-
getTimeOfLastDeliveryAttempt
java.util.Date getTimeOfLastDeliveryAttempt()
Retrieve the time at which the last delivery attempt was made, ornull
if there have been no previous delivery attempts.- Returns:
- The time at which the last delivery attempt was made, or
null
if there have been no previous delivery attempts.
-
-