Package com.i2group.disco.alerts

Interface IAlertManager

public interface IAlertManager

A set of methods for creating and reporting on alerts that you can send to specified users of an i2 Analyze deployment. Access to the IAlertManager is available through IScheduledTask.onStartup(com.i2group.disco.task.spi.IScheduledTask.IScheduledTaskObjects).

Since:

12.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IAlertManager.IAlertCreationResult	The result of a request to create an alert.

Method Summary

Modifier and Type	Method	Description
IAlertManager.IAlertCreationResult	createAlert(ISendTo sendTo, String title, AlertIcon icon, String message, String href)	Creates and sends an alert with an optional message and an optional hyperlink.
IAlertManager.IAlertCreationResult	createRecordsAlert(ISendTo sendTo, String title, AlertIcon icon, String message, Collection<String> recordIdentifiers)	Creates and sends an alert that contains one or more records and an optional message.

Method Details

createAlert

IAlertManager.IAlertCreationResult createAlert(ISendTo sendTo,
 String title,
 AlertIcon icon,
 String message,
 String href)
                                        throws SQLException

Creates and sends an alert with an optional message and an optional hyperlink.

Parameters:

sendTo - The criteria that determine the list of users to whom the alert is sent.

title - The title of the alert, which is displayed to users in a list that might contain many alerts.

icon - The icon to associate with the alert in the user interface, which defaults to AlertIcon.INFORMATION.

message - A message to include in the alert, which might be displayed alongside the title; or null for no message.

href - A URL to add to the alert, so that users who receive the alert can follow a link to more information; or null for no link.

Returns:

A report that contains the number of users to whom the alert was sent.

Throws:

IllegalArgumentException - If a required argument is missing or not valid.

SQLException - If an error occurs while storing the alert in the database.

createRecordsAlert

IAlertManager.IAlertCreationResult createRecordsAlert(ISendTo sendTo,
 String title,
 AlertIcon icon,
 String message,
 Collection<String> recordIdentifiers)
                                               throws SQLException

Creates and sends an alert that contains one or more records and an optional message.

Parameters:

sendTo - The criteria that determine the list of users to whom the alert is sent.

title - The title of the alert, which is displayed to users in a list that might contain many alerts.

icon - The icon to associate with the alert in the user interface, which defaults to AlertIcon.INFORMATION.

message - A message to include in the alert, which might be displayed alongside the title; or null for no message.

recordIdentifiers - The identifiers of records to add to the alert, so that users who receive the alert can view the records in question.

Returns:

A report that contains the number of users to whom the alert was sent.

Throws:

IllegalArgumentException - If a required argument is missing or not valid.

SQLException - If an error occurs while storing the alert in the database.