com.liferay.content.targeting.api.model

Interface RuleCategory

All Known Implementing Classes:

BaseRuleCategory, BehaviorRuleCategory, SampleRuleCategory, SessionAttributesRuleCategory, SocialRuleCategory, UserAttributesRuleCategory

public interface RuleCategory

Provides the Rule Category interface, allowing custom rule category creation for aggregation of Rules for the Content Targeting Portlet.

Method Summary

Modifier and Type	Method and Description
void	activate()
void	deActivate()
java.lang.String	getCategoryKey() Returns the key that identifies the category of the rule.
java.lang.String	getDescription(java.util.Locale locale) Returns the rule category description.
java.lang.String	getIcon() Returns the Font Awesome CSS class for the rule catetory's icon.
java.lang.String	getName(java.util.Locale locale) Returns the rule category's name.

Method Detail

activate

void activate()

deActivate

void deActivate()

getCategoryKey

java.lang.String getCategoryKey()

Returns the key that identifies the category of the rule.

Returns:

the key that identifies the category

getDescription

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

Returns the rule category description.

Parameters:

locale - the language's locale

Returns:

the rule locale

getIcon

java.lang.String getIcon()

Returns the Font Awesome CSS class for the rule catetory's icon.

Returns:

the Font Awesome CSS class for the rule category's icon

See Also:

Font Awesome documentation

getName

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

Returns the rule category's name.

Parameters:

locale - the language's locale

Returns:

the rule's name