com.crystaldecisions.sdk.plugin.desktop.common
Interface IReportAlerts

All Superinterfaces:
java.util.Collection, java.util.List

public interface IReportAlerts
extends java.util.List

This collection contains the list of alerts defined in a given report. You can set the configuration options for each alert, and then send these alerts to an SMTP server. Use the setBody(String) method to include a message that will be shown in the alert notification email before all of the alert messages.

Information about report alert destinations can be found using the ISchedulingInfo getAlertDestination method. This method returns the IDestination object that contains the report alert destination. To disable alert notification for a report, set the IDestination method setName to an empty String.

Note: This collection can be accessed through the IReportProcessingInfo.getReportAlerts() method of the IReportProcessingInfo interface.


Method Summary
 java.lang.String getBody()
          Returns the message text that is prepended to the notification email.
 void setBody(java.lang.String Body)
          Sets the message text that is prepended to the alert notification email.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

getBody

public java.lang.String getBody()
                         throws SDKException

Returns the message text that is prepended to the notification email. The maximum number of characters that you can include in the message text may be constrained by limits that have been put on your SMTP server.

Use the ISchedulingInfo interface's AlertDestination method to set the notification email. This email will contain all of the triggered alerts in a given report.

Returns:
A String containing the message text that is prepended to the alert notification email.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setBody

public void setBody(java.lang.String Body)

Sets the message text that is prepended to the alert notification email. The maximum number of characters that you can include in the message text may be constrained by limits that have been put on your SMTP server.

Use the ISchedulingInfo interface's AlertDestination method to set the alert notification email. This email will contain all of the triggered alerts in a given report.

To insert a viewer hyperlink into the message body, add %SI_VIEWER_URL% to the string. See setEmbeddedLinkURL for more information.

Parameters:
Body - A String containing the message text that is prepended to the alert notification email.