Package org.silverpeas.core.notification.user.client

Class NotificationParameters

java.lang.Object

org.silverpeas.core.notification.user.client.NotificationParameters

public class NotificationParameters
extends Object

All the parameters required to send a notification with the NotificationManager

Version:

%I%, %G%

Author:

Thierry Leroi

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_SIZE_TITLE
static int	PRIORITY_ERROR	The message is for an error.
static int	PRIORITY_NORMAL	The priority of the message is normal.
static int	PRIORITY_URGENT	The message is urgent.

Constructor Summary

Constructors

Constructor	Description
NotificationParameters()

Method Summary

Modifier and Type	Method	Description
NotifAction	getAction()
int	getAddressId()
int	getComponentInstance()
Date	getDate()
int	getFromUserId()
String	getLanguage()
Link	getLink()
String	getMessage()
int	getMessagePriority()
NotificationResourceData	getNotificationResourceData()
String	getOriginalExtraMessage()
String	getSenderName()
String	getSessionId()
String	getSource()
String	getTitle()
boolean	isAddressDefinedByComponent()
boolean	isAnswerAllowed()
boolean	isComponentInstanceDefined()
boolean	isFromUserIdDefined()
boolean	isSendImmediately()
NotificationParameters	setAction(NotifAction eAction)
NotificationParameters	setAddressId(int notifMediaType)
NotificationParameters	setAnswerAllowed(boolean bAnswerAllowed)
NotificationParameters	setComponentInstance(int iComponentInstance)
NotificationParameters	setDate(Date dDate)
NotificationParameters	setFromUserId(int iFromUserId)
NotificationParameters	setLanguage(String sLanguage)
NotificationParameters	setLink(Link link)
NotificationParameters	setMessage(String sMessage)
NotificationParameters	setMessagePriority(int iMessagePriority)
NotificationParameters	setNotificationResourceData(NotificationResourceData nNotificationResourceData)
NotificationParameters	setOriginalExtraMessage(String sOriginalExtraMessage)
NotificationParameters	setSenderName(String senderName)
NotificationParameters	setSendImmediately(boolean bSendImmediately)
NotificationParameters	setSessionId(String sSessionId)
NotificationParameters	setSource(String sSource)
NotificationParameters	setTitle(String sTitle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRIORITY_NORMAL

public static final int PRIORITY_NORMAL

The priority of the message is normal.

See Also:

Constant Field Values

PRIORITY_URGENT

public static final int PRIORITY_URGENT

The message is urgent.

See Also:

Constant Field Values

PRIORITY_ERROR

public static final int PRIORITY_ERROR

The message is for an error.

See Also:

Constant Field Values

MAX_SIZE_TITLE

public static final int MAX_SIZE_TITLE

See Also:

Constant Field Values

Constructor Detail

NotificationParameters

public NotificationParameters()

Method Detail

getMessagePriority

public int getMessagePriority()

setMessagePriority

public NotificationParameters setMessagePriority(int iMessagePriority)

getAddressId

public int getAddressId()

setAddressId

public NotificationParameters setAddressId(int notifMediaType)

isAddressDefinedByComponent

public boolean isAddressDefinedByComponent()

getComponentInstance

public int getComponentInstance()

setComponentInstance

public NotificationParameters setComponentInstance(int iComponentInstance)

isComponentInstanceDefined

public boolean isComponentInstanceDefined()

getFromUserId

public int getFromUserId()

setFromUserId

public NotificationParameters setFromUserId(int iFromUserId)

isFromUserIdDefined

public boolean isFromUserIdDefined()

getTitle

public String getTitle()

setTitle

public NotificationParameters setTitle(String sTitle)

getSenderName

public String getSenderName()

setSenderName

public NotificationParameters setSenderName(String senderName)

getMessage

public String getMessage()

setMessage

public NotificationParameters setMessage(String sMessage)

getLink

public Link getLink()

setLink

public NotificationParameters setLink(Link link)

getSource

public String getSource()

setSource

public NotificationParameters setSource(String sSource)

getSessionId

public String getSessionId()

setSessionId

public NotificationParameters setSessionId(String sSessionId)

getOriginalExtraMessage

public String getOriginalExtraMessage()

setOriginalExtraMessage

public NotificationParameters setOriginalExtraMessage(String sOriginalExtraMessage)

isAnswerAllowed

public boolean isAnswerAllowed()

setAnswerAllowed

public NotificationParameters setAnswerAllowed(boolean bAnswerAllowed)

isSendImmediately

public boolean isSendImmediately()

setSendImmediately

public NotificationParameters setSendImmediately(boolean bSendImmediately)

getDate

public Date getDate()

setDate

public NotificationParameters setDate(Date dDate)

getLanguage

public String getLanguage()

setLanguage

public NotificationParameters setLanguage(String sLanguage)

getAction

public NotifAction getAction()

setAction

public NotificationParameters setAction(NotifAction eAction)

getNotificationResourceData

public NotificationResourceData getNotificationResourceData()

setNotificationResourceData

public NotificationParameters setNotificationResourceData(NotificationResourceData nNotificationResourceData)