Class AlertHandler

All Implemented Interfaces:
JcmsConstants, JaliosConstants
Direct Known Subclasses:
AlertAppHandler, AlertTopbarHandler

public class AlertHandler extends JcmsFormHandler
A super handler to query loggedMember's alerts.
Since:
jcms-10.0.0
Author:
Sylvain Devaux
  • Field Details

    • PARAM_ALERT_AUTHOR

      public static final String PARAM_ALERT_AUTHOR
      See Also:
    • PARAM_ALERT_END_DATE

      public static final String PARAM_ALERT_END_DATE
      See Also:
    • PARAM_ALERT_START_DATE

      public static final String PARAM_ALERT_START_DATE
      See Also:
    • PARAM_ALERT_WORKSPACE

      public static final String PARAM_ALERT_WORKSPACE
      See Also:
    • PARAM_ALERT_PAGER_REVERSE

      public static final String PARAM_ALERT_PAGER_REVERSE
      See Also:
    • PARAM_ALERT_PAGER_START

      public static final String PARAM_ALERT_PAGER_START
      See Also:
    • PARAM_ALERT_DAILYDATE

      public static final String PARAM_ALERT_DAILYDATE
      See Also:
    • PARAM_ALERT_DISPLAYED_ALERTS

      public static final String PARAM_ALERT_DISPLAYED_ALERTS
      See Also:
    • PARAM_ALERT_LEVEL

      public static final String PARAM_ALERT_LEVEL
      See Also:
    • PARAM_ALERT_READ_MODE

      public static final String PARAM_ALERT_READ_MODE
      See Also:
    • DEFAULT_READ_MODE

      public static final AlertQueryBuilder.ReadMode DEFAULT_READ_MODE
    • PARAM_MORE_DATE

      public static final String PARAM_MORE_DATE
      See Also:
    • opUnfollow

      protected boolean opUnfollow
    • opUnfollowRead

      protected boolean opUnfollowRead
    • opReadAllPub

      protected boolean opReadAllPub
    • alertPageResult

      protected PageResult<Alert> alertPageResult
    • aqb

      protected AlertQueryBuilder aqb
    • alertAuthor

      protected Member alertAuthor
    • alertStartDate

      protected Date alertStartDate
    • alertEndDate

      protected Date alertEndDate
    • alertDailyDate

      protected boolean alertDailyDate
    • displayedAlertRowIdSet

      protected Set<Long> displayedAlertRowIdSet
    • alertWorkspace

      protected Workspace alertWorkspace
    • alertReadMode

      protected AlertQueryBuilder.ReadMode alertReadMode
    • DEFAULT_ALERT_LEVELS

      protected static final Alert.Level[] DEFAULT_ALERT_LEVELS
    • alertLevelList

      protected Alert.Level[] alertLevelList
    • moreDate

      protected Date moreDate
    • opRead

      protected boolean opRead
    • opUnread

      protected boolean opUnread
    • opReadAll

      protected boolean opReadAll
    • DEFAULT_REVERSE

      protected static final boolean DEFAULT_REVERSE
      See Also:
    • sort

      protected String sort
    • reverse

      protected boolean reverse
    • start

      protected int start
    • pageSize

      protected int pageSize
    • pagerAll

      protected boolean pagerAll
  • Constructor Details

    • AlertHandler

      public AlertHandler()
  • Method Details

    • processAction

      public boolean processAction() throws IOException
      Description copied from class: JcmsFormHandler
      Method to be implemented to check/validate action to be performed and process them.

      Default implementation is to return false. No need to call super method.

      This method may NOT be invoked at all if security validation are not met.

      You must ensure your handler and JSP can work properly without any code invoked in this method.

      Overrides:
      processAction in class JcmsFormHandler
      Returns:
      false if no redirection is needed, true otherwise
      Throws:
      IOException - IO Exception
    • validateMember

      protected boolean validateMember()
      Returns:
      true if loggedMember is not null, false otherwise.
      Since:
      jcms-10.0.2
    • getFormStepHiddenFields

      public String getFormStepHiddenFields()
      Overrides:
      getFormStepHiddenFields in class JcmsFormHandler
      Since:
      jcms-10.0.2
    • getResultsCount

      public int getResultsCount()
      Returns:
      results count for current user filters
      Since:
      jcms-10.0.2
      See Also:
    • getAlertsPageResult

      public PageResult<Alert> getAlertsPageResult()
    • initSort

      protected void initSort()
    • setSortAndReverse

      protected void setSortAndReverse(MemberAlertSettings.Sort alertSort)
    • getMoreDateRestriction

      protected org.hibernate.criterion.SimpleExpression getMoreDateRestriction()
      Returns:
      date restriction for "More" button, with reverse param handled.
      Since:
      jcms-10.0.2
    • setAlertAuthor

      public void setAlertAuthor(String v)
    • getAvailableAlertAuthor

      public Member getAvailableAlertAuthor()
      Returns:
      the member to use as author filter
      Since:
      jcms-10.0.0
    • setAlertStartDate

      public void setAlertStartDate(String dateStr)
    • getAvailableAlertStartDate

      public Date getAvailableAlertStartDate()
    • getAvailableAlertEndDate

      public Date getAvailableAlertEndDate()
    • setAlertEndDate

      public void setAlertEndDate(String dateStr)
    • setAlertDailyDate

      public void setAlertDailyDate(String v)
    • setAlertDisplayedAlerts

      public void setAlertDisplayedAlerts(String v)
    • setAlertWorkspace

      public void setAlertWorkspace(String v)
    • getAvailableAlertWorkspace

      public Workspace getAvailableAlertWorkspace()
    • setAlertReadMode

      public void setAlertReadMode(String alertReadMode)
    • getAvailableAlertReadMode

      public AlertQueryBuilder.ReadMode getAvailableAlertReadMode()
    • isReadModeRead

      public boolean isReadModeRead()
    • isReadModeUnread

      public boolean isReadModeUnread()
    • isReadAllMode

      public boolean isReadAllMode()
    • setAlertLevel

      public void setAlertLevel(String[] v)
    • getAvailableAlertLevels

      public Alert.Level[] getAvailableAlertLevels()
    • getAvailableAlertLevelList

      public List<Alert.Level> getAvailableAlertLevelList()
    • getAvailableAlertLevelListValues

      protected List<String> getAvailableAlertLevelListValues()
      Internal. Used to fill the controlTag with user value(s).
      Returns:
      the VALUES of the alert level list
    • isLevelInfo

      public boolean isLevelInfo()
    • isLevelWarning

      public boolean isLevelWarning()
    • isLevelAction

      public boolean isLevelAction()
    • setAlertMoreDate

      public void setAlertMoreDate(String v)
    • hasMore

      public boolean hasMore()
      True if there are more Datas than the default results list.
      Returns:
      true ie More button should be displayed
    • getMoreDate

      protected Date getMoreDate()
      Returns:
      if there are result(s), the creation date of last result.
      Since:
      jcms-10.0.2
    • getMoreAlertParamsMap

      protected Map<String,Map<String,?>> getMoreAlertParamsMap()
      Returns:
      params for More button
      Since:
      jcms-10.0.2
    • setMoreAlertScrollParams

      protected void setMoreAlertScrollParams(Map<String,Object> paramsSecondMap)
    • getMoreAlertParams

      public String getMoreAlertParams()
      Compute the AJAX parameters for the AJAX "more" button
      Returns:
      a JSON map for data-jalios-options
      Since:
      jcms-10.0.0
    • setOpRead

      public void setOpRead(String v)
    • setOpUnread

      public void setOpUnread(String v)
    • setOpReadAll

      public void setOpReadAll(String v)
    • setAlerts

      public void setAlerts(String[] v)
    • getAvailableAlerts

      public Collection<Alert> getAvailableAlerts()
    • showResultList

      public boolean showResultList()
      Convenient method to indicate to the UI if results view will rendered.

      Return false to indicate APP Body is something else than results.

      Returns:
      weither result list is to be rendered (whatever results count). true by default
      Since:
      jcms-10.0.2
    • showMarkAllAsRead

      public boolean showMarkAllAsRead()
      Returns true when there are at least one unread alert.
      Returns:
      weither action "Mark all (alerts) as read" should be provided to the user
      Since:
      jcms-10.0.2
    • hasResults

      public boolean hasResults()
      Returns:
      true if there is at least one result and results list is to be displayed.
      Since:
      jcms-10.0.2
      See Also:
    • setAlertAppPager_sort

      public void setAlertAppPager_sort(String v)
    • getSort

      public String getSort()
    • setAlertAppPager_reverse

      @Deprecated public void setAlertAppPager_reverse(String v)
      Deprecated.
    • setAlertListReverse

      public void setAlertListReverse(String v)
      To change alert list order to be reverse or not.
      Parameters:
      v - reverse order to set
      Since:
      jcms-10.0.3
    • setReverse

      public void setReverse(boolean v)
    • isReverse

      public boolean isReverse()
      Returns:
      weither alert list order must be reverse or not.

      If user reverse choice misses from HTTP parameters, loads member preference if any.

      Else, return default reverse.

      Since:
      jcms-10.0.3
    • getMemberAlertSettings

      protected MemberAlertSettings getMemberAlertSettings()
    • setAlertAppPager_start

      public void setAlertAppPager_start(String v)
    • getStart

      public int getStart()
    • setAlertAppPager_pageSize

      public void setAlertAppPager_pageSize(String v)
    • getPageSize

      public int getPageSize()
    • setAlertAppPager_pagerAll

      public void setAlertAppPager_pagerAll(String v)
    • isPagerAll

      public boolean isPagerAll()
    • getAlertStatusResponse

      public final String getAlertStatusResponse()
      Returns:
      the AlertStatus as a String for current logged member
    • getAlertParentDataId

      public static String getAlertParentDataId(Alert alert)
      Searches for the alert data (If available) parent
      Parameters:
      alert - Alert
      Returns:
      the alert Data parent id
      Since:
      jcms-10.0.2
    • isOpUnfollow

      public boolean isOpUnfollow()
    • setOpUnfollow

      public void setOpUnfollow(boolean opUnfollow)
    • isOpUnfollowRead

      public boolean isOpUnfollowRead()
    • setOpUnfollowRead

      public void setOpUnfollowRead(boolean opUnfollowRead)
    • isOpReadAllPub

      public boolean isOpReadAllPub()
    • setOpReadAllPub

      public void setOpReadAllPub(boolean opReadAllPub)
    • isUnfollowableAlert

      public static boolean isUnfollowableAlert(Alert alert, Member mbr)
      Parameters:
      alert - the Alert
      mbr - the Member
      Returns:
      true if given Alert is unfollowable for given Member
      Since:
      jcms-10.0.2
    • isReadAllAlert

      public static boolean isReadAllAlert(Alert alert)
      Parameters:
      alert - the Alert
      Returns:
      true if the Alert can provide read all action (All alerts on the same data will be marked as read)
      Since:
      jcms-10.0.2