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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSetting.FREQUENCY

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMAIL_CHANNEL

Constructor Summary

Constructors

Constructor and Description
UserSetting()

Method Summary

Modifier and Type	Method and Description
void	addChannelPlugin(String channelId, String pluginId) Add the pluginId by channel
void	addPlugin(String pluginId, UserSetting.FREQUENCY frequencyType)
UserSetting	clone()
boolean	equals(Object o)
Map<String,List<String>>	getAllChannelPlugins()
List<String>	getChannelActives()
List<String>	getDailyPlugins()
static UserSetting	getInstance()
long	getLastReadDate() Get the last read date
Calendar	getLastUpdateTime()
List<String>	getPlugins(String channelId)
String	getUserId()
List<String>	getWeeklyPlugins()
int	hashCode()
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.
boolean	isChannelActive(String channelId)
boolean	isEnabled()
boolean	isInDaily(String pluginId)
boolean	isInWeekly(String pluginId)
void	removeChannelActive(String channelId)
void	removeChannelPlugin(String channelId, String pluginId) remove the pluginId on channel
void	removePlugin(String pluginId, UserSetting.FREQUENCY frequencyType)
void	setAllChannelPlugins(Map<String,List<String>> channelPlugins)
void	setChannelActive(String channelId)
void	setChannelActives(List<String> channelActives)
void	setChannelPlugins(String channelId, List<String> pluginIds)
void	setDailyPlugins(List<String> dailyPlugins)
void	setEnabled(boolean isEnabled)
void	setLastReadDate(long lastReadDate) Set last read date
UserSetting	setLastUpdateTime(Calendar lastUpdateTime)
UserSetting	setUserId(String userId)
void	setWeeklyPlugins(List<String> weeklyPlugins)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMAIL_CHANNEL

public static String EMAIL_CHANNEL

Constructor Detail

UserSetting

public UserSetting()

Method Detail

getInstance

public static UserSetting getInstance()

getLastReadDate

public long getLastReadDate()

Get the last read date

Returns:

setLastReadDate

public void setLastReadDate(long lastReadDate)

Set last read date

Parameters:

lastReadDate -

getChannelActives

public List<String> getChannelActives()

Returns:

isChannelActive

public boolean isChannelActive(String channelId)

Returns:

setChannelActive

public void setChannelActive(String channelId)

Parameters:

channelId -

removeChannelActive

public void removeChannelActive(String channelId)

Parameters:

channelId -

setChannelActives

public void setChannelActives(List<String> channelActives)

Parameters:

channelActives -

getUserId

public String getUserId()

Returns:

the userId

setUserId

public UserSetting setUserId(String userId)

Parameters:

userId - the userId to set

getLastUpdateTime

public Calendar getLastUpdateTime()

Returns:

the lastUpdateTime

setLastUpdateTime

public UserSetting setLastUpdateTime(Calendar lastUpdateTime)

Parameters:

lastUpdateTime - the lastUpdateTime to set

setAllChannelPlugins

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

Parameters:

channelPlugins - the channelPlugins to set

getAllChannelPlugins

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

Returns:

the all channelPlugins

getPlugins

public List<String> getPlugins(String channelId)

Returns:

the channelPlugins

setChannelPlugins

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

Parameters:

channelId -

pluginIds -

addChannelPlugin

public void addChannelPlugin(String channelId,
                             String pluginId)

Add the pluginId by channel

Parameters:

channelId -

pluginId -

removeChannelPlugin

public void removeChannelPlugin(String channelId,
                                String pluginId)

remove the pluginId on channel

Parameters:

channelId -

pluginId -

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

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:

pluginId -

Returns:

isInDaily

public boolean isInDaily(String pluginId)

Parameters:

pluginId -

Returns:

isInWeekly

public boolean isInWeekly(String pluginId)

Parameters:

pluginId -

Returns:

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