com.isti.quakewatch.alert
Interface AlertSenderInterface

All Known Subinterfaces:
AlertEmailSenderInterface
All Known Implementing Classes:
AlertEmailSender

public interface AlertSenderInterface

Interface AlertSenderInterface defines an alert sender interface.


Method Summary
 java.lang.String getDisplayStr()
          Returns a display string for the alert sender.
 int getMaxSendMessageRetries()
          Returns the maximum number of retries to attempt when the sending of an alert message is failing.
 boolean sendMessage(AlertRecipient recipObj, java.lang.Object alertMsgObj)
          Sends an alert message using the given parameters.
 

Method Detail

getDisplayStr

java.lang.String getDisplayStr()
Returns a display string for the alert sender.

Returns:
a display string for the alert sender.

getMaxSendMessageRetries

int getMaxSendMessageRetries()
Returns the maximum number of retries to attempt when the sending of an alert message is failing.

Returns:
The maximum number of send alert message retries after failure.

sendMessage

boolean sendMessage(AlertRecipient recipObj,
                    java.lang.Object alertMsgObj)
Sends an alert message using the given parameters. If the previous send attempt failed then this method may perform a wait-delay before sending the message.

Parameters:
recipObj - the alert recipient for the message.
alertMsgObj - the alert message object.
Returns:
true if successful; false if not (in which case a warning message will be logged).