AlertPolicyFilter (JCMS API)

All Superinterfaces:

java.lang.Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicAlertPolicyFilter
```
public interface AlertPolicyFilter
extends PolicyFilter
```
This interface provides hooks for Alert management.

Since:

jcms-8.0.0

Version:

$Revision: 43280 $

Author:

Olivier Dedieu

Field Summary
- Fields inherited from interface com.jalios.jcms.plugin.PluginComponent
  REVISION

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Alert`	`beforeSendAlert(Alert alert, AlertChannel alertChannel)`	This method is called before sending an alert in a given alert channel.
`java.util.Set<AlertChannel>`	`getAlertChannelSet(Alert alert, java.util.Set<AlertChannel> alertChannelSet)`	This method is called before sending an alert to filter the alert channel set to use.
`boolean`	`saveAlert(Alert alert, boolean saveAlert)`	This method is called before saving an alert.

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent
init

- Method Detail
  - getAlertChannelSet
```
java.util.Set<AlertChannel> getAlertChannelSet(Alert alert,
                                               java.util.Set<AlertChannel> alertChannelSet)
```
    This method is called before sending an alert to filter the alert channel set to use.
    
    Parameters:
    
    alert - the alert
    
    alertChannelSet - the proposed alertChannelSet for this alert
    
    Returns:
    
    the alertChannelSet to use for this sending.
    
    Since:
    
    jcms-8.0.0
  - beforeSendAlert
```
Alert beforeSendAlert(Alert alert,
                      AlertChannel alertChannel)
```
    This method is called before sending an alert in a given alert channel.
    
    Parameters:
    
    alert - the alert
    
    alertChannel - the alertChannel
    
    Returns:
    
    the alert to be sent in the given AlertChannel
    
    Since:
    
    jcms-8.0.0
  - saveAlert
```
boolean saveAlert(Alert alert,
                  boolean saveAlert)
```
    This method is called before saving an alert.
    
    Parameters:
    
    alert - the alert to be saved
    
    saveAlert - the default value
    
    Returns:
    
    true if the alert must saved false otherwise
    
    Since:
    
    jcms-8.0.0