org.broadleafcommerce.cms.structure.domain

Interface StructuredContentItemCriteria

All Superinterfaces:

Serializable

All Known Implementing Classes:

StructuredContentItemCriteriaImpl

public interface StructuredContentItemCriteria
extends Serializable

Implementations of this interface contain item rule data that is used for targeting StructuredContent items.

For example, a StructuredContent item could be setup to only show to user's who have a particular product in their cart.

Author:

bpolster

See Also:

StructuredContentCartRuleProcessor

Method Summary

Methods

Modifier and Type	Method and Description
StructuredContentItemCriteria	cloneEntity() Builds a copy of this item.
Long	getId() Gets the primary key.
String	getOrderItemMatchRule() Returns the MVEL rule to apply against an order to determine if this content should be displayed.
Integer	getQuantity()
StructuredContent	getStructuredContent() Returns the parent StructuredContent item to which this field belongs.
void	setId(Long id) Sets the primary key.
void	setOrderItemMatchRule(String orderItemMatchRule) An valid MVEL syntax rule to be used to process the
void	setQuantity(Integer quantity)
void	setStructuredContent(StructuredContent structuredContent) Sets the parent StructuredContent 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

getQuantity

Integer getQuantity()

Returns:

setQuantity

void setQuantity(Integer quantity)

Parameters:

quantity -

getOrderItemMatchRule

String getOrderItemMatchRule()

Returns the MVEL rule to apply against an order to determine if this content should be displayed.

Returns:

the rule as an MVEL string

setOrderItemMatchRule

void setOrderItemMatchRule(String orderItemMatchRule)

An valid MVEL syntax rule to be used to process the

Parameters:

orderItemMatchRule -

getStructuredContent

@Nonnull
StructuredContent getStructuredContent()

Returns the parent StructuredContent item to which this field belongs.

Returns:

setStructuredContent

void setStructuredContent(@Nonnull
                        StructuredContent structuredContent)

Sets the parent StructuredContent item.

Parameters:

structuredContent -

cloneEntity

@Nonnull
StructuredContentItemCriteria cloneEntity()

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

Returns:

a copy of this item