com.broadleafcommerce.advancedcms.domain.targeting

Interface ContentTargeter

All Superinterfaces:

org.broadleafcommerce.common.copy.MultiTenantCloneable<ContentTargeter>, Serializable

All Known Implementing Classes:

ContentTargeterImpl

public interface ContentTargeter
extends Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<ContentTargeter>

A ContentTargetingRule is used to change the value of a content item when certain rules are met.

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
Date	getActiveEndDate() Returns the last date this ContentTargeter will be active.
Date	getActiveStartDate() Returns the first date this ContentTargeter will be used.
ContentTargetingAction	getContentTargetingAction() Returns the action associated with this targeter (when there is only one action).
List<ContentTargetingActionXref>	getContentTargetingActions() Returns a the list of actions to take for this targeter.
String	getDescription() Gets the description.
Long	getId() Gets the primary key.
Map<String,ContentTargetingRuleXref>	getMatchRules() Returns a map of the rules that determine if this targeter applies
String	getName() Gets the name.
Integer	getPriority() Gets the integer priority of this content targeting rule.
Set<ContentTargetingItemCriteria>	getQualifyingItemCriteria() Returns a map of the cart based rules that determine if this targeter applies.
void	setActiveEndDate(Date activeEndDate) Sets the last date this ContentTargeter will be active.
void	setActiveStartDate(Date activeStartDate) Sets the first date this ContentTargeter will be used.
void	setContentTargetingAction(ContentTargetingAction targetingAction) Sets the action associated with this targeter (when there is only one action).
void	setContentTargetingActions(List<ContentTargetingActionXref> contentTargetingActions) Sets the list of actions to take for this targeter.
void	setDescription(String description) Sets the description.
void	setId(Long id) Sets the primary key.
void	setMatchRules(Map<String,ContentTargetingRuleXref> matchRules) Sets the rules that determine if this targeter applies
void	setName(String name) Sets the name.
void	setPriority(Integer priority) Sets the priority for this rule.
void	setQualifyingItemCriteria(Set<ContentTargetingItemCriteria> qualifyingItemCriteria) Sets a map of the cart based rules that determine if this targeter applies.

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

createOrRetrieveCopyInstance

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

getName

@Nonnull
String getName()

Gets the name.

Returns:

the name

setDescription

void setDescription(@Nonnull
                    String description)

Sets the description.

Parameters:

description -

getDescription

@Nonnull
String getDescription()

Gets the description.

Returns:

the description

setName

void setName(@Nonnull
             String name)

Sets the name.

Parameters:

name -

getActiveStartDate

Date getActiveStartDate()

Returns the first date this ContentTargeter will be used. A value of null means that this targeter is not active and should not be run.

Returns:

the first date the targeter will be used

setActiveStartDate

void setActiveStartDate(Date activeStartDate)

Sets the first date this ContentTargeter will be used. A value of null means that this targeter is not active and should not be run.

Parameters:

activeStartDate - - the first day the targeter will be used

getActiveEndDate

Date getActiveEndDate()

Returns the last date this ContentTargeter will be active. A value of null should be interpreted as a targeter that has no end date.

Returns:

the last day the targeter should be run.

setActiveEndDate

void setActiveEndDate(Date activeEndDate)

Sets the last date this ContentTargeter will be active.

Parameters:

activeEndDate - - the last day the targeter will nul

getMatchRules

@Nullable
Map<String,ContentTargetingRuleXref> getMatchRules()

Returns a map of the rules that determine if this targeter applies

Returns:

setMatchRules

void setMatchRules(@Nullable
                   Map<String,ContentTargetingRuleXref> matchRules)

Sets the rules that determine if this targeter applies

Parameters:

matchRules -

getQualifyingItemCriteria

@Nullable
Set<ContentTargetingItemCriteria> getQualifyingItemCriteria()

Returns a map of the cart based rules that determine if this targeter applies.

Returns:

setQualifyingItemCriteria

void setQualifyingItemCriteria(Set<ContentTargetingItemCriteria> qualifyingItemCriteria)

Sets a map of the cart based rules that determine if this targeter applies.

Parameters:

matchRules -

getPriority

@Nullable
Integer getPriority()

Gets the integer priority of this content targeting rule. If multiple content rules can apply to a given context, the one with the highest priority will apply.

Returns:

the priority as a numeric value

setPriority

void setPriority(@Nullable
                 Integer priority)

Sets the priority for this rule. If multiple rules match for a given page, content-slot, etc., then the one with the highest priority will win.

Parameters:

priority -

getContentTargetingAction

ContentTargetingAction getContentTargetingAction()

Returns the action associated with this targeter (when there is only one action).

Returns:

the single ContentAction

setContentTargetingAction

void setContentTargetingAction(ContentTargetingAction targetingAction)

Sets the action associated with this targeter (when there is only one action).

Parameters:

-

getContentTargetingActions

List<ContentTargetingActionXref> getContentTargetingActions()

Returns a the list of actions to take for this targeter.

Returns:

setContentTargetingActions

void setContentTargetingActions(List<ContentTargetingActionXref> contentTargetingActions)

Sets the list of actions to take for this targeter.

Parameters:

contentTargetingActions -