Package org.broadleafcommerce.cms.structure.domain

Interface StructuredContentRule

All Superinterfaces:

MultiTenantCloneable<StructuredContentRule>, Serializable, SimpleRule

All Known Implementing Classes:

StructuredContentRuleImpl

public interface StructuredContentRule
extends SimpleRule, MultiTenantCloneable<StructuredContentRule>

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:

• org.broadleafcommerce.cms.web.structure.DisplayContentTag
• StructuredContentServiceImpl.evaluateAndPriortizeContent(java.util.List, int, java.util.Map)

Method Summary

Modifier and Type	Method	Description
StructuredContentRule	cloneEntity()	Builds a copy of this content rule.
Long	getId()	Gets the primary key.
void	setId(Long id)	Sets the primary key.

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Methods inherited from interface org.broadleafcommerce.common.rule.SimpleRule

getMatchRule, setMatchRule

Method Details

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

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