Package org.exoplatform.commons.api.notification.model

Class UserSetting

java.lang.Object
org.exoplatform.commons.api.notification.model.UserSetting
public class UserSetting extends Object
User setting notification

  • Field Details

  • Constructor Details

    • UserSetting

      public UserSetting()

  • Method Details

    • getInstance

      public static UserSetting getInstance()

    • getLastReadDate

      public long getLastReadDate()

    • setLastReadDate

      public void setLastReadDate(long lastReadDate)

    • getChannelActives

      public Set<String> getChannelActives()

    • isChannelGloballyActive

      public boolean isChannelGloballyActive(String channelId)

    • isChannelActive

      public boolean isChannelActive(String channelId, String pluginId)

    • setChannelActive

      public void setChannelActive(String channelId)

    • removeChannelActive

      public void removeChannelActive(String channelId)

    • setChannelActives

      public void setChannelActives(Set<String> channelActives)

    • getUserId

      public String getUserId()

    • setUserId

      public UserSetting setUserId(String userId)

    • getLastUpdateTime

      public Calendar getLastUpdateTime()

    • setLastUpdateTime

      public UserSetting setLastUpdateTime(Calendar lastUpdateTime)

    • setAllChannelPlugins

      public void setAllChannelPlugins(Map<String,List<String>> channelPlugins)

    • getAllChannelPlugins

      public Map<String,List<String>> getAllChannelPlugins()

    • getPlugins

      public List<String> getPlugins(String channelId)

    • setChannelPlugins

      public void setChannelPlugins(String channelId, List<String> pluginIds)

    • addChannelPlugin

      public void addChannelPlugin(String channelId, String pluginId)
      Add the pluginId by channel
      Parameters:
      channelId - Channel identifier
      pluginId - Plugin identifier

    • removeChannelPlugin

      public void removeChannelPlugin(String channelId, String pluginId)
      remove the pluginId on channel
      Parameters:
      channelId - Channel identifier
      pluginId - Plugin identifier

    • getDailyPlugins

      public List<String> getDailyPlugins()
      Returns:
      the dailyPlugins

    • setDailyPlugins

      public void setDailyPlugins(List<String> dailyPlugins)
      Parameters:
      dailyPlugins - the dailyPlugins to set

    • getWeeklyPlugins

      public List<String> getWeeklyPlugins()
      Returns:
      the weeklyPlugins

    • setWeeklyPlugins

      public void setWeeklyPlugins(List<String> weeklyPlugins)
      Parameters:
      weeklyPlugins - the weeklyPlugins to set

    • addPlugin

      public void addPlugin(String pluginId, UserSetting.FREQUENCY frequencyType)
      Parameters:
      pluginId - the provider's id to add
      frequencyType - UserSetting.FREQUENCY of notification plugin

    • removePlugin

      public void removePlugin(String pluginId, UserSetting.FREQUENCY frequencyType)

    • isActive

      public boolean isActive(String channelId, String pluginId)
      Checks the user's setting for the channel and the plugin if it's active, it's instantly including the email channel.
      Parameters:
      channelId - Channel identifier
      pluginId - Plugin identifier
      Returns:
      true if active, else false

    • isInDaily

      public boolean isInDaily(String pluginId)

    • isInWeekly

      public boolean isInWeekly(String pluginId)

    • clone

      public UserSetting clone()
      Overrides:
      clone in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public void setEnabled(boolean isEnabled)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object