com.liferay.content.targeting.api.model

Class BaseRule

java.lang.Object

com.liferay.content.targeting.api.model.BaseRule

All Implemented Interfaces:

Rule

Direct Known Subclasses:

BaseFreemarkerRule, BaseJSPRule

public abstract class BaseRule
extends java.lang.Object
implements Rule

Constructor Summary

Constructors

Constructor and Description
BaseRule()

Method Summary

Modifier and Type	Method and Description
void	activate() Does processing when the rule is installed.
void	deActivate() Does processing when the rule is uninstalled.
void	deleteData(RuleInstance ruleInstance) Removes any additional data added by this rule when the rule instance is removed.
boolean	evaluate(java.util.Map<java.lang.String,java.lang.Object> context, RuleInstance ruleInstance, com.liferay.content.targeting.anonymous.users.model.AnonymousUser anonymousUser) Returns true if the user complies with the rule instance in an offline mode.
void	exportData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext, com.liferay.portal.kernel.xml.Element userSegmentElement, UserSegment userSegment, com.liferay.portal.kernel.xml.Element ruleInstanceElement, RuleInstance ruleInstance) Exports any additional data added by this rule when the rule instance is exported.
long	getCacheTime() Returns the time in milliseconds that the evaluation of this rule can be cached.
java.lang.String	getDescription(java.util.Locale locale) Returns the rule's localized description.
protected java.lang.String	getExportImportErrorMessage(UserSegment userSegment, RuleInstance ruleInstance, java.lang.String missingReferenceClassName, java.lang.String missingReferenceId, java.lang.String action)
java.lang.String	getIcon() Returns the Font Awesome CSS class for the rule icon.
java.lang.String	getName(java.util.Locale locale) Returns the rule's localized name.
java.lang.String	getRuleCategoryKey() Returns the key that identifies the category of the rule.
java.lang.String	getRuleKey() Returns the key that identifies the rule.
java.lang.String	getShortDescription(java.util.Locale locale) Returns the rule's localized short description.
void	importData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext, UserSegment userSegment, RuleInstance ruleInstance) Imports any additional data added by this rule when the rule instance is imported.
boolean	isInstantiable() Returns true if the rule can be used more than once with different values for a user segment.
boolean	isVisible() Returns true if the rule is visible.
boolean	supportsOfflineEvaluation() Returns true if the rule can be evaluated offline (without the user request in real time).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.content.targeting.api.model.Rule

evaluate, getFormHTML, getSummary, processRule

Constructor Detail

BaseRule

public BaseRule()

Method Detail

activate

public void activate()

Description copied from interface: Rule

Does processing when the rule is installed.

Specified by:

activate in interface Rule

deActivate

public void deActivate()

Description copied from interface: Rule

Does processing when the rule is uninstalled.

Specified by:

deActivate in interface Rule

deleteData

public void deleteData(RuleInstance ruleInstance)
                throws com.liferay.portal.kernel.exception.PortalException

Description copied from interface: Rule

Removes any additional data added by this rule when the rule instance is removed.

Specified by:

deleteData in interface Rule

Parameters:

ruleInstance - the rule instance with the stored configuration

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

evaluate

public boolean evaluate(java.util.Map<java.lang.String,java.lang.Object> context,
                        RuleInstance ruleInstance,
                        com.liferay.content.targeting.anonymous.users.model.AnonymousUser anonymousUser)

Description copied from interface: Rule

Returns true if the user complies with the rule instance in an offline mode. The evaluation is completed without having a user request. This will only be called if the rule supports offline evaluation (see method Rule.supportsOfflineEvaluation()). A context map can be optionally passed with some context variables.

Specified by:

evaluate in interface Rule

Parameters:

context - a map of objects that can be used to evaluate the rule instance

ruleInstance - the rule instance with stored configuration

anonymousUser - the user who evaluates the rule

Returns:

true if the user complies with the rule instance in an offline mode; false otherwise

exportData

public void exportData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext,
                       com.liferay.portal.kernel.xml.Element userSegmentElement,
                       UserSegment userSegment,
                       com.liferay.portal.kernel.xml.Element ruleInstanceElement,
                       RuleInstance ruleInstance)
                throws java.lang.Exception

Description copied from interface: Rule

Exports any additional data added by this rule when the rule instance is exported.

Specified by:

exportData in interface Rule

Parameters:

portletDataContext - the context of the data export

userSegmentElement - the element with the user segment export data

userSegment - the user segment containing the rule instance

ruleInstanceElement - the element with the rule instance export data

ruleInstance - the rule instance with stored configuration

Throws:

java.lang.Exception - if an exception occurred

getCacheTime

public long getCacheTime()

Description copied from interface: Rule

Returns the time in milliseconds that the evaluation of this rule can be cached. For example, an Age rule can be cached at least 1 day and a Geolocation rule could be cached 5 minutes. This value can be configurable by adding a custom configuration to your component. A value of 0 means that the evaluation can not be cached.

Specified by:

getCacheTime in interface Rule

Returns:

the time in milliseconds

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: Rule

Returns the rule's localized description.

Specified by:

getDescription in interface Rule

Parameters:

locale - the language locale

Returns:

the rule's localized description

getIcon

public java.lang.String getIcon()

Description copied from interface: Rule

Returns the Font Awesome CSS class for the rule icon.

Specified by:

getIcon in interface Rule

Returns:

the Font Awesome CSS class for the rule icon

See Also:

Font Awesome documentation

getName

public java.lang.String getName(java.util.Locale locale)

Description copied from interface: Rule

Returns the rule's localized name.

Specified by:

getName in interface Rule

Parameters:

locale - the language locale

Returns:

the rule's localized name

getRuleCategoryKey

public java.lang.String getRuleCategoryKey()

Description copied from interface: Rule

Returns the key that identifies the category of the rule.

Specified by:

getRuleCategoryKey in interface Rule

Returns:

the key that identifies the category

getRuleKey

public java.lang.String getRuleKey()

Description copied from interface: Rule

Returns the key that identifies the rule. The rule instances of this rule are identified by their rule key.

Specified by:

getRuleKey in interface Rule

Returns:

the key that identifies the rule

getShortDescription

public java.lang.String getShortDescription(java.util.Locale locale)

Description copied from interface: Rule

Returns the rule's localized short description.

Specified by:

getShortDescription in interface Rule

Parameters:

locale - the language locale

Returns:

the rule's localized short description

importData

public void importData(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext,
                       UserSegment userSegment,
                       RuleInstance ruleInstance)
                throws java.lang.Exception

Description copied from interface: Rule

Imports any additional data added by this rule when the rule instance is imported.

Specified by:

importData in interface Rule

Parameters:

portletDataContext - the context of the data import

userSegment - the user segment containing the rule instance

ruleInstance - the rule instance with stored configuration

Throws:

java.lang.Exception - if an exception occurred

isInstantiable

public boolean isInstantiable()

Description copied from interface: Rule

Returns true if the rule can be used more than once with different values for a user segment.

Specified by:

isInstantiable in interface Rule

Returns:

true if the rule can be used more than once; false otherwise

isVisible

public boolean isVisible()

Description copied from interface: Rule

Returns true if the rule is visible.

Specified by:

isVisible in interface Rule

Returns:

true if the rule is visible; false otherwise

supportsOfflineEvaluation

public boolean supportsOfflineEvaluation()

Description copied from interface: Rule

Returns true if the rule can be evaluated offline (without the user request in real time). If this is set to true, the method Rule.evaluate(Map, RuleInstance, AnonymousUser) should be implemented.

Specified by:

supportsOfflineEvaluation in interface Rule

Returns:

true if the rule can be evaluated offline; false otherwise.

getExportImportErrorMessage

protected java.lang.String getExportImportErrorMessage(UserSegment userSegment,
                                                       RuleInstance ruleInstance,
                                                       java.lang.String missingReferenceClassName,
                                                       java.lang.String missingReferenceId,
                                                       java.lang.String action)