com.broadleafcommerce.advancedcms.domain.targeting

Interface ContentTargetingAction

All Superinterfaces:

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

All Known Implementing Classes:

ContentTargetingActionImpl

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

Actions to take if a content targeter is valid.

Author:

bpolster

See Also:

ContentTargeter, ContentTargetingActionType

Method Summary

Modifier and Type	Method and Description
ContentTargetingActionType	getContentTargetingActionType() Returns the targeting action type.
ContentZone	getContentZone() Returns the associated zone.
String	getFieldKey() For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, returns the key of field being changed.
Long	getId() Gets the primary key.
ContentItem	getNewContentItem() Returns the replacement content item for the zone getContentZone() For action types of ContentTargetingActionType.CHANGE_ITEM_IN_ZONE
String	getNewFieldValue() For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, returns the replacement value of field associated with getFieldKey().
org.broadleafcommerce.cms.page.domain.Page	getNewPage() Returns the replacement Page that should be displayed in place of getPage() when using the action types of ContentTargetingActionType.CHANGE_PAGE.
com.broadleafcommerce.theme.domain.ThemeConfiguration	getNewTheme() Returns the replacement ThemeConfiguration that should be displayed when using the action types of ContentTargetingActionType.CHANGE_THEME.
com.broadleafcommerce.theme.domain.ThemeFile	getNewThemeFile() Returns the replacement ThemeFile that should be displayed in place of getThemeFile() when using the action types of ContentTargetingActionType.CHANGE_TEMPLATE.
org.broadleafcommerce.cms.page.domain.Page	getPage() Returns the Page that we want to effect with this content targeter.
com.broadleafcommerce.theme.domain.ThemeFile	getThemeFile() Returns the template ThemeFile that we want to effect with this content targeter.
void	setContentTargetingActionType(ContentTargetingActionType actionType) Sets the targeting action type.
void	setContentZone(ContentZone zone) Sets the zone associated with this targeting action.
void	setFieldKey(String fieldKey) For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, sets the key of the field being changed.
void	setId(Long id) Sets the primary key.
void	setNewContentItem(ContentItem contentItem) Sets the content item that you want to be served in the content zone when using an action types of ContentTargetingActionType.CHANGE_ITEM_IN_ZONE
void	setNewFieldValue(String newFieldValue) For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, sets the new value for the field associated with getFieldKey()
void	setNewPage(org.broadleafcommerce.cms.page.domain.Page newPage) Sets the replacement Page that should be displayed in place of getPage() when using the action types of ContentTargetingActionType.CHANGE_PAGE.
void	setNewTheme(com.broadleafcommerce.theme.domain.ThemeConfiguration theme) Sets the replacement ThemeConfiguration that should be displayed when using the action types of ContentTargetingActionType.CHANGE_THEME.
void	setNewThemeFile(com.broadleafcommerce.theme.domain.ThemeFile newThemeFile) Sets the replacement ThemeFile that should be displayed in place of getThemeFile() when using the action types of ContentTargetingActionType.CHANGE_TEMPLATE.
void	setPage(org.broadleafcommerce.cms.page.domain.Page page) Sets the Page you want to effect with this content targeter.
void	setThemeFile(com.broadleafcommerce.theme.domain.ThemeFile themeFile) Sets the template ThemeFile you want to effect with this content targeter.

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

getContentTargetingActionType

ContentTargetingActionType getContentTargetingActionType()

Returns the targeting action type.

Returns:

See Also:

ContentTargetingActionType

setContentTargetingActionType

void setContentTargetingActionType(ContentTargetingActionType actionType)

Sets the targeting action type.

Parameters:

actionType -

getContentZone

ContentZone getContentZone()

Returns the associated zone. For action types of ContentTargetingActionType.CHANGE_ITEM_IN_ZONE

Returns:

setContentZone

void setContentZone(ContentZone zone)

Sets the zone associated with this targeting action. For action types of ContentTargetingActionType.CHANGE_ITEM_IN_ZONE

Parameters:

zone -

getNewContentItem

ContentItem getNewContentItem()

Returns the replacement content item for the zone getContentZone() For action types of ContentTargetingActionType.CHANGE_ITEM_IN_ZONE

Returns:

setNewContentItem

void setNewContentItem(ContentItem contentItem)

Sets the content item that you want to be served in the content zone when using an action types of ContentTargetingActionType.CHANGE_ITEM_IN_ZONE

Parameters:

contentItem -

getPage

org.broadleafcommerce.cms.page.domain.Page getPage()

Returns the Page that we want to effect with this content targeter. For action types of ContentTargetingActionType.CHANGE_PAGE and ContentTargetingActionType.CHANGE_PAGE_VARIABLE

Returns:

setPage

void setPage(org.broadleafcommerce.cms.page.domain.Page page)

Sets the Page you want to effect with this content targeter. For action types of ContentTargetingActionType.CHANGE_PAGE and ContentTargetingActionType.CHANGE_PAGE_VARIABLE

Parameters:

page -

getNewPage

org.broadleafcommerce.cms.page.domain.Page getNewPage()

Returns the replacement Page that should be displayed in place of getPage() when using the action types of ContentTargetingActionType.CHANGE_PAGE.

Returns:

setNewPage

void setNewPage(org.broadleafcommerce.cms.page.domain.Page newPage)

Sets the replacement Page that should be displayed in place of getPage() when using the action types of ContentTargetingActionType.CHANGE_PAGE.

Parameters:

newPage -

getFieldKey

String getFieldKey()

For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, returns the key of field being changed.

Returns:

setFieldKey

void setFieldKey(String fieldKey)

For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, sets the key of the field being changed.

Parameters:

fieldKey -

getNewFieldValue

String getNewFieldValue()

For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, returns the replacement value of field associated with getFieldKey(). For example, a page might have a field named "body" which this targeter replaces.

Returns:

setNewFieldValue

void setNewFieldValue(String newFieldValue)

For action with a type of ContentTestActionType#CHANGE_PAGE_VARIABLE, sets the new value for the field associated with getFieldKey()

Parameters:

newFieldValue -

getThemeFile

com.broadleafcommerce.theme.domain.ThemeFile getThemeFile()

Returns the template ThemeFile that we want to effect with this content targeter. For action types of ContentTargetingActionType.CHANGE_TEMPLATE

Returns:

setThemeFile

void setThemeFile(com.broadleafcommerce.theme.domain.ThemeFile themeFile)

Sets the template ThemeFile you want to effect with this content targeter. For action types of ContentTargetingActionType.CHANGE_TEMPLATE

Parameters:

themeFile -

getNewThemeFile

com.broadleafcommerce.theme.domain.ThemeFile getNewThemeFile()

Returns the replacement ThemeFile that should be displayed in place of getThemeFile() when using the action types of ContentTargetingActionType.CHANGE_TEMPLATE.

Returns:

setNewThemeFile

void setNewThemeFile(com.broadleafcommerce.theme.domain.ThemeFile newThemeFile)

Sets the replacement ThemeFile that should be displayed in place of getThemeFile() when using the action types of ContentTargetingActionType.CHANGE_TEMPLATE.

Parameters:

newThemeFile -

getNewTheme

com.broadleafcommerce.theme.domain.ThemeConfiguration getNewTheme()

Returns the replacement ThemeConfiguration that should be displayed when using the action types of ContentTargetingActionType.CHANGE_THEME.

Returns:

setNewTheme

void setNewTheme(com.broadleafcommerce.theme.domain.ThemeConfiguration theme)

Sets the replacement ThemeConfiguration that should be displayed when using the action types of ContentTargetingActionType.CHANGE_THEME.

Parameters:

newThemeFile -