Package org.opencms.notification

Class CmsNotificationCandidates

java.lang.Object

org.opencms.notification.CmsNotificationCandidates

public class CmsNotificationCandidates
extends Object

The basic class for the content notification feature in OpenCms. Collects all resources that require a notification, creates and sends notifications to their responsible users.

Constructor Summary

Constructors

Constructor	Description
CmsNotificationCandidates(CmsObject cms)	Collects all resources that will expire in short time, or will become valid, or are not modified since a long time.

Method Summary

Modifier and Type	Method	Description
protected Collection<CmsContentNotification>	getContentNotifications()	Returns a collection of CmsContentNotifications, one for each responsible that receives a notification.
String	notifyResponsibles()	Sends all notifications to the responsible users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsNotificationCandidates

public CmsNotificationCandidates(CmsObject cms)
                          throws CmsException

Collects all resources that will expire in short time, or will become valid, or are not modified since a long time.

Parameters:

cms - the CmsObject

Throws:

CmsException - if something goes wrong

Method Details

notifyResponsibles

public String notifyResponsibles()
                          throws CmsException

Sends all notifications to the responsible users.

Returns:

a string listing all responsibles that a notification was sent to

Throws:

CmsException - if something goes wrong

getContentNotifications

protected Collection<CmsContentNotification> getContentNotifications()
                                                              throws CmsException

Returns a collection of CmsContentNotifications, one for each responsible that receives a notification.

Returns:

the list of CmsContentNotifications, one for each responsible that receives a notification

Throws:

CmsException - if something goes wrong