org.broadleafcommerce.cms.structure.domain

Interface StructuredContentRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

StructuredContentRuleImpl

public interface StructuredContentRule
extends Serializable

Implementations hold the values for a rule used to determine if a StructuredContent item should be displayed.
The rule is represented as a valid MVEL string. The Content Management System by default is able to process rules based on the current customer, product, time, or request

Author:

jfischer, bpolster

See Also:

DisplayContentTag, StructuredContentServiceImpl.evaluateAndPriortizeContent(java.util.List, int, java.util.Map)

Method Summary

Methods

Modifier and Type	Method and Description
StructuredContentRule	cloneEntity() Builds a copy of this content rule.
Long	getId() Gets the primary key.
String	getMatchRule()
void	setId(Long id) Sets the primary key.
void	setMatchRule(String matchRule) Sets the match rule used to test this item.

Method Detail

getId

@Nullable
Long getId()

Gets the primary key.

Returns:

the primary key

setId

void setId(@Nullable
         Long id)

Sets the primary key.

Parameters:

id - the new primary key

getMatchRule

@Nonnull
String getMatchRule()

Returns:

the rule as an MVEL string

setMatchRule

void setMatchRule(@Nonnull
                String matchRule)

Sets the match rule used to test this item.

Parameters:

matchRule -

cloneEntity

@Nonnull
StructuredContentRule cloneEntity()

Builds a copy of this content rule. Used by the content management system when an item is edited.

Returns:

a copy of this rule