com.liferay.portal.notifications

Class UserNotificationManagerImpl

java.lang.Object

com.liferay.portal.notifications.UserNotificationManagerImpl

All Implemented Interfaces:

com.liferay.portal.kernel.notifications.UserNotificationManager

public class UserNotificationManagerImpl
extends java.lang.Object
implements com.liferay.portal.kernel.notifications.UserNotificationManager

Author:

Jonathan Lee, Brian Wing Shun Chan

Constructor Summary

Constructors

Constructor and Description
UserNotificationManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserNotificationDefinition(java.lang.String portletId, com.liferay.portal.kernel.notifications.UserNotificationDefinition userNotificationDefinition)
void	addUserNotificationHandler(com.liferay.portal.kernel.notifications.UserNotificationHandler userNotificationHandler) Adds the use notification handler to the list of available handlers.
void	deleteUserNotificationDefinitions(java.lang.String portletId)
void	deleteUserNotificationHandler(com.liferay.portal.kernel.notifications.UserNotificationHandler userNotificationHandler)
com.liferay.portal.kernel.notifications.UserNotificationDefinition	fetchUserNotificationDefinition(java.lang.String portletId, long classNameId, int notificationType)
java.util.Map<java.lang.String,java.util.List<com.liferay.portal.kernel.notifications.UserNotificationDefinition>>	getUserNotificationDefinitions()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,com.liferay.portal.kernel.notifications.UserNotificationHandler>>	getUserNotificationHandlers()
com.liferay.portal.kernel.notifications.UserNotificationFeedEntry	interpret(java.lang.String selector, com.liferay.portal.model.UserNotificationEvent userNotificationEvent, com.liferay.portal.service.ServiceContext serviceContext) Creates a human readable user notification feed entry for the user notification using an available compatible user notification handler.
boolean	isDeliver(long userId, java.lang.String portletId, long classNameId, int notificationType, int deliveryType)
boolean	isDeliver(long userId, java.lang.String selector, java.lang.String portletId, long classNameId, int notificationType, int deliveryType, com.liferay.portal.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNotificationManagerImpl

public UserNotificationManagerImpl()

Method Detail

addUserNotificationDefinition

public void addUserNotificationDefinition(java.lang.String portletId,
                                 com.liferay.portal.kernel.notifications.UserNotificationDefinition userNotificationDefinition)

Specified by:

addUserNotificationDefinition in interface com.liferay.portal.kernel.notifications.UserNotificationManager

addUserNotificationHandler

public void addUserNotificationHandler(com.liferay.portal.kernel.notifications.UserNotificationHandler userNotificationHandler)

Adds the use notification handler to the list of available handlers.

Specified by:

addUserNotificationHandler in interface com.liferay.portal.kernel.notifications.UserNotificationManager

Parameters:

userNotificationHandler - the user notification handler

deleteUserNotificationDefinitions

public void deleteUserNotificationDefinitions(java.lang.String portletId)

Specified by:

deleteUserNotificationDefinitions in interface com.liferay.portal.kernel.notifications.UserNotificationManager

deleteUserNotificationHandler

public void deleteUserNotificationHandler(com.liferay.portal.kernel.notifications.UserNotificationHandler userNotificationHandler)

Specified by:

deleteUserNotificationHandler in interface com.liferay.portal.kernel.notifications.UserNotificationManager

fetchUserNotificationDefinition

public com.liferay.portal.kernel.notifications.UserNotificationDefinition fetchUserNotificationDefinition(java.lang.String portletId,
                                                                                                 long classNameId,
                                                                                                 int notificationType)

Specified by:

fetchUserNotificationDefinition in interface com.liferay.portal.kernel.notifications.UserNotificationManager

getUserNotificationDefinitions

public java.util.Map<java.lang.String,java.util.List<com.liferay.portal.kernel.notifications.UserNotificationDefinition>> getUserNotificationDefinitions()

Specified by:

getUserNotificationDefinitions in interface com.liferay.portal.kernel.notifications.UserNotificationManager

getUserNotificationHandlers

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,com.liferay.portal.kernel.notifications.UserNotificationHandler>> getUserNotificationHandlers()

Specified by:

getUserNotificationHandlers in interface com.liferay.portal.kernel.notifications.UserNotificationManager

interpret

public com.liferay.portal.kernel.notifications.UserNotificationFeedEntry interpret(java.lang.String selector,
                                                                          com.liferay.portal.model.UserNotificationEvent userNotificationEvent,
                                                                          com.liferay.portal.service.ServiceContext serviceContext)
                                                                            throws com.liferay.portal.kernel.exception.PortalException

Creates a human readable user notification feed entry for the user notification using an available compatible user notification handler.

This method finds the appropriate handler for the user notification by going through the available handler and asking them if they can handle the user notidication based on the portlet.

Specified by:

interpret in interface com.liferay.portal.kernel.notifications.UserNotificationManager

Parameters:

userNotificationEvent - the user notification event to be translated to human readable form

Returns:

the user notification feed that is a human readable form of the user notification record or null if a compatible handler is not found

Throws:

com.liferay.portal.kernel.exception.PortalException

isDeliver

public boolean isDeliver(long userId,
                java.lang.String portletId,
                long classNameId,
                int notificationType,
                int deliveryType)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException

Specified by:

isDeliver in interface com.liferay.portal.kernel.notifications.UserNotificationManager

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

isDeliver

public boolean isDeliver(long userId,
                java.lang.String selector,
                java.lang.String portletId,
                long classNameId,
                int notificationType,
                int deliveryType,
                com.liferay.portal.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException

Specified by:

isDeliver in interface com.liferay.portal.kernel.notifications.UserNotificationManager

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException