Package org.opencms.notification

Class CmsNotificationCandidates

  • public class CmsNotificationCandidates
extends java.lang.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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.util.Collection<CmsContentNotification> getContentNotifications()
      Returns a collection of CmsContentNotifications, one for each responsible that receives a notification.
      java.lang.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 Detail

      • 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 Detail

      • notifyResponsibles

        public java.lang.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 java.util.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