Package org.silverpeas.web.notificationuser.control

Class UserNotificationSessionController

java.lang.Object

org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

org.silverpeas.web.notificationuser.control.UserNotificationSessionController

All Implemented Interfaces:

Serializable, ComponentSessionController, SessionCloseable

public class UserNotificationSessionController
extends AbstractComponentSessionController

See Also:

Serialized Form

Field Summary

Fields inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

context

Constructor Summary

Constructors

Constructor	Description
UserNotificationSessionController(MainSessionController mainSessionCtrl, ComponentContext componentContext)	Constructor declaration

Method Summary

Modifier and Type	Method	Description
void	clearNotification()	Clears any prepared notification.
List<Group>	getGroupsFrom(String groupIdsLine)	Gets the list of groups whose the identifiers are specified in the given line.
List<User>	getUsersFrom(String userIdsLine)	Gets the list of users whose the identifiers are specified in the given line.
UserNotification	prepareNotification(NotificationContext context)	Prepares a user notification from the specified context ready to be customized by the notification editor and then to be sent later.
void	sendNotification(NotificationContext context)	Sends the notification described by the specified context.

Methods inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

addClipboardSelection, clipboardPasteDone, close, getClipboardErrorMessage, getClipboardExceptionError, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getHighestSilverpeasUserRole, getIcon, getLanguage, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoles, getZoneId, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardSelectedElement, setComponentRootName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNotificationSessionController

public UserNotificationSessionController(MainSessionController mainSessionCtrl,
                                         ComponentContext componentContext)

Constructor declaration

Method Detail

getUsersFrom

public List<User> getUsersFrom(String userIdsLine)

Gets the list of users whose the identifiers are specified in the given line.

Parameters:

userIdsLine - a line of underscore-separated user's unique identifiers.

Returns:

a list of users.

getGroupsFrom

public List<Group> getGroupsFrom(String groupIdsLine)

Gets the list of groups whose the identifiers are specified in the given line.

Parameters:

groupIdsLine - a line of underscore-separated group's unique identifiers.

Returns:

a list of groups.

prepareNotification

public UserNotification prepareNotification(NotificationContext context)

Prepares a user notification from the specified context ready to be customized by the notification editor and then to be sent later.

Parameters:

context - a notification context. It can contain additional parameters specific to a given Silverpeas component instance.

Returns:

the user notification that will be sent later.

clearNotification

public void clearNotification()

Clears any prepared notification.

sendNotification

public void sendNotification(NotificationContext context)

Sends the notification described by the specified context.

Parameters:

context - the context of the notification to send. It contains all the properties required to build the notification and to send it.