com.endeca.messaging.rules

Class RulesEngine

java.lang.Object

com.endeca.messaging.rules.RulesEngine

public class RulesEngine
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static MessagingManager	messagingManager

Constructor Summary

Constructors

Constructor and Description
RulesEngine()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addNotifications(Message message) This method determines the scope of for the given message and then adds a notification record for the given message for each user in the scope.
static NotificationRuleViewModel	apply(Message message, javax.portlet.PortletRequest request) Given a message, a request object, and a condition type, determine the NotificationRuleViewModel that applies to this message.
static NotificationRuleViewModel	apply(Message message, javax.portlet.PortletRequest request, java.lang.String condition) Given a message and a condition string, determine the NotificationRuleViewModel that applies to this message.
static NotificationRuleViewModel	apply(java.lang.String eventName, java.lang.String status, java.lang.String role, java.lang.String condition) Given the primary key of NotificationRuleViewModel, return a NotificationRuleViewModel contains information that can be used by the UI, such as message resource string, priority, activity, etc.
static java.lang.String	getCondition(Message message) Given a message, a request object, and a condition type, determine string value of the condition

Methods inherited from class java.lang.Object

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

Field Detail

messagingManager

public static final MessagingManager messagingManager

Constructor Detail

RulesEngine

public RulesEngine()

Method Detail

addNotifications

public static void addNotifications(Message message)
                             throws NotificationRuleException

This method determines the scope of for the given message and then adds a notification record for the given message for each user in the scope.

Parameters:

message -

Throws:

org.codehaus.jackson.JsonParseException

org.codehaus.jackson.map.JsonMappingException

java.io.IOException

com.liferay.portal.PortalException

com.liferay.portal.SystemException

NotificationRuleException

apply

public static NotificationRuleViewModel apply(Message message,
                              javax.portlet.PortletRequest request)
                                       throws NotificationRuleException

Given a message, a request object, and a condition type, determine the NotificationRuleViewModel that applies to this message. The return NotificationRuleViewModel contains information that can be used by the UI, such as message resource string, priority, activity, etc.

Parameters:

message -

request -

type -

Returns:

NotificationRuleViewModel

Throws:

NotificationRuleException

apply

public static NotificationRuleViewModel apply(Message message,
                              javax.portlet.PortletRequest request,
                              java.lang.String condition)
                                       throws NotificationRuleException

Given a message and a condition string, determine the NotificationRuleViewModel that applies to this message. The return NotificationRuleViewModel contains information that can be used by the UI, such as message resource string, priority, activity, etc.

Parameters:

message -

condition -

Returns:

notificationRule

Throws:

NotificationRuleException

apply

public static NotificationRuleViewModel apply(java.lang.String eventName,
                              java.lang.String status,
                              java.lang.String role,
                              java.lang.String condition)
                                       throws NotificationRuleException

Given the primary key of NotificationRuleViewModel, return a NotificationRuleViewModel contains information that can be used by the UI, such as message resource string, priority, activity, etc.

Parameters:

eventName -

status -

isProjectMember -

isAdmin -

condition -

Returns:

Throws:

NotificationRuleException

getCondition

public static java.lang.String getCondition(Message message)
                                     throws NotificationRuleException

Given a message, a request object, and a condition type, determine string value of the condition

Parameters:

message -

request -

type -

Returns:

the String value of the condition

Throws:

NotificationRuleException