org.exoplatform.commons.api.notification.model

Class NotificationInfo

java.lang.Object

org.exoplatform.commons.api.notification.model.NotificationInfo

public class NotificationInfo
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOR_ALL_USER
static String	PREFIX_ID

Constructor Summary

Constructors

Constructor and Description
NotificationInfo()

Method Summary

Methods

Modifier and Type	Method and Description
NotificationInfo	clone()
NotificationInfo	end()
boolean	equals(Object o)
String[]	getArrayOwnerParameter()
String	getFrom()
String	getId()
NotificationKey	getKey()
int	getOrder()
Map<String,String>	getOwnerParameter()
String[]	getSendToDaily()
List<String>	getSendToUserIds()
String[]	getSendToWeekly()
String	getTo()
String	getValueOwnerParameter(String key)
static NotificationInfo	instance()
boolean	isSendAll()
NotificationInfo	key(NotificationKey key)
NotificationInfo	key(String id)
NotificationInfo	removeOnSendToDaily(String userId)
NotificationInfo	removeOnSendToWeekly(String userId)
NotificationInfo	setFrom(String from)
NotificationInfo	setId(String id)
NotificationInfo	setOrder(int order)
NotificationInfo	setOwnerParameter(Map<String,String> ownerParameter)
NotificationInfo	setOwnerParameter(javax.jcr.Value[] values)
NotificationInfo	setSendAll(boolean isSendAll)
NotificationInfo	setSendToDaily(String userId)
NotificationInfo	setSendToDaily(String[] userIds)
NotificationInfo	setSendToWeekly(String userId)
NotificationInfo	setSendToWeekly(String[] userIds)
NotificationInfo	setTo(String to)
NotificationInfo	to(List<String> sendToUserIds)
NotificationInfo	to(String sendToUserId)
String	toString()
NotificationInfo	with(String key, String value)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_ID

public static final String PREFIX_ID

See Also:

Constant Field Values

FOR_ALL_USER

public static final String FOR_ALL_USER

See Also:

Constant Field Values

Constructor Detail

NotificationInfo

public NotificationInfo()

Method Detail

instance

public static NotificationInfo instance()

getId

public String getId()

setId

public NotificationInfo setId(String id)

setSendAll

public NotificationInfo setSendAll(boolean isSendAll)

isSendAll

public boolean isSendAll()

getKey

public NotificationKey getKey()

key

public NotificationInfo key(NotificationKey key)

key

public NotificationInfo key(String id)

getFrom

public String getFrom()

setFrom

public NotificationInfo setFrom(String from)

getTo

public String getTo()

Returns:

the to

setTo

public NotificationInfo setTo(String to)

Parameters:

to - the to to set

getOrder

public int getOrder()

Returns:

the order

setOrder

public NotificationInfo setOrder(int order)

Parameters:

order - the order to set

getSendToUserIds

public List<String> getSendToUserIds()

to

public NotificationInfo to(List<String> sendToUserIds)

to

public NotificationInfo to(String sendToUserId)

getOwnerParameter

public Map<String,String> getOwnerParameter()

Returns:

the ownerParameter

getValueOwnerParameter

public String getValueOwnerParameter(String key)

Returns:

the value of ownerParameter

getArrayOwnerParameter

public String[] getArrayOwnerParameter()

Returns:

the array ownerParameter

setOwnerParameter

public NotificationInfo setOwnerParameter(Map<String,String> ownerParameter)

Parameters:

ownerParameter - the ownerParameter to set

with

public NotificationInfo with(String key,
                    String value)

Parameters:

ownerParameter - the ownerParameter to set

end

public NotificationInfo end()

setOwnerParameter

public NotificationInfo setOwnerParameter(javax.jcr.Value[] values)

Parameters:

arrays - the value to set ownerParameter

getSendToDaily

public String[] getSendToDaily()

Returns:

the sendToDaily

setSendToDaily

public NotificationInfo setSendToDaily(String[] userIds)

Parameters:

userIds - the list userIds to set for sendToDaily

setSendToDaily

public NotificationInfo setSendToDaily(String userId)

Parameters:

userId - the userId to add into sendToDaily

removeOnSendToDaily

public NotificationInfo removeOnSendToDaily(String userId)

Parameters:

userId - the userId to remove into sendToDaily

getSendToWeekly

public String[] getSendToWeekly()

Returns:

the sendToWeekly

setSendToWeekly

public NotificationInfo setSendToWeekly(String[] userIds)

Parameters:

userIds - the list userIds to set for sendToWeekly

setSendToWeekly

public NotificationInfo setSendToWeekly(String userId)

Parameters:

userId - the userId to add into sendToWeekly

removeOnSendToWeekly

public NotificationInfo removeOnSendToWeekly(String userId)

Parameters:

userId - the userId to remove into sendToWeekly

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public NotificationInfo clone()

Overrides:

clone in class Object