com.broadleafcommerce.contenttests.domain

Interface ContentTestAction

All Known Subinterfaces:

ContentTestAdditionalAction, ContentTestVariation

All Known Implementing Classes:

ContentTestAdditionalActionImpl, ContentTestVariationImpl

public interface ContentTestAction

Created by Chris on 3/27/17.

Method Summary

Modifier and Type	Method and Description
ContentTestActionType	getContentTestActionType() Returns the action type.
com.broadleafcommerce.advancedcms.domain.ContentZone	getLookupContentZone() Returns the associated content item to have its content replaced.
com.broadleafcommerce.advancedcms.domain.ContentItem	getNewContentItem() Returns the associated replacement content item.
org.broadleafcommerce.cms.page.domain.Page	getNewPage() Returns the associated page.
Integer	getNewPriority() Returns the new priority for an item of type ContentTestActionType.CHANGE_CONTENT_PRIORITY
String	getNewPropertyValue() For action with a type of ContentTestActionType.CHANGE_VARIABLE, returns the value of the new template path.
org.broadleafcommerce.common.config.domain.SystemProperty	getNewSystemProperty() For action with a type of ContentTestActionType.CHANGE_VARIABLE, returns the SystemProperty whose value should be changed to the value of getNewPropertyValue()
com.broadleafcommerce.theme.domain.ThemeFile	getNewTemplate() Returns the new template.
String	getNewTemplatePath() For action with a type of ContentTestActionType.CHANGE_TEMPLATE_PATH, returns the value of the new template path.
String	getNewUrl() For action with a type of ContentTestActionType.CHANGE_URL, returns the value of the new url.
org.broadleafcommerce.cms.structure.domain.StructuredContent	getPriorityContent() Returns the associated structured content item.
String	getRequestContextAttribute() Returns the name of the selected price list for an action of type
String	getRequestContextValue() Returns the value of the request context attribute
void	setContentTestActionType(ContentTestActionType actionType) Sets the action type.
void	setLookupContentZone(com.broadleafcommerce.advancedcms.domain.ContentZone contentZone) Sets the associated content zone to have its content replaced
void	setNewContentItem(com.broadleafcommerce.advancedcms.domain.ContentItem contentItem) Sets the associated replacement content item.
void	setNewPage(org.broadleafcommerce.cms.page.domain.Page newPage) Sets the page you want to show instead of the current URL.
void	setNewPriority(Integer priority) Sets the new priority for an item of type ContentTestActionType.CHANGE_CONTENT_PRIORITY
void	setNewPropertyValue(String newValue) For action with a type of ContentTestActionType.CHANGE_VARIABLE, sets the value of the new template path.
void	setNewSystemProperty(org.broadleafcommerce.common.config.domain.SystemProperty property) For action with a type of ContentTestActionType.CHANGE_VARIABLE, sets the SystemProperty whose value should be changed to the value of getNewPropertyValue()
void	setNewTemplate(com.broadleafcommerce.theme.domain.ThemeFile newTemplate) Sets the template you want to show instead of the current template.
void	setNewTemplatePath(String newPath) For action with a type of ContentTestActionType.CHANGE_TEMPLATE_PATH, sets the value of the new template path.
void	setNewUrl(String newUrl) For action with a type of ContentTestActionType.CHANGE_URL, sets the value of the new url.
void	setPriorityContent(org.broadleafcommerce.cms.structure.domain.StructuredContent priorityContent) Sets the associated structured content item.
void	setRequestContextAttribute(String requestContextAttribute) Sets the name of the selected price list for an action of type
void	setRequestContextValue(String requestContextValue)

Method Detail

getContentTestActionType

ContentTestActionType getContentTestActionType()

Returns the action type.

Returns:

See Also:

ContentTestActionType

setContentTestActionType

void setContentTestActionType(ContentTestActionType actionType)

Sets the action type.

Parameters:

actionType -

getLookupContentZone

com.broadleafcommerce.advancedcms.domain.ContentZone getLookupContentZone()

Returns the associated content item to have its content replaced. For action types of

Returns:

setLookupContentZone

void setLookupContentZone(com.broadleafcommerce.advancedcms.domain.ContentZone contentZone)

Sets the associated content zone to have its content replaced

Parameters:

contentZone -

getNewContentItem

com.broadleafcommerce.advancedcms.domain.ContentItem getNewContentItem()

Returns the associated replacement content item. For action types of ContentTestActionType.CHANGE_CONTENT

Returns:

setNewContentItem

void setNewContentItem(com.broadleafcommerce.advancedcms.domain.ContentItem contentItem)

Sets the associated replacement content item.

Parameters:

contentItem -

getNewPage

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

Returns the associated page. For action types of ContentTestActionType.CHANGE_PAGE

Returns:

setNewPage

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

Sets the page you want to show instead of the current URL.

Parameters:

newPage -

getNewTemplate

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

Returns the new template. This field is used if the action type is ContentTestActionType.CHANGE_TEMPLATE.

Returns:

setNewTemplate

void setNewTemplate(com.broadleafcommerce.theme.domain.ThemeFile newTemplate)

Sets the template you want to show instead of the current template. Can fail if the template chosen is not valid for the target URLs.

Parameters:

newTemplate -

getNewTemplatePath

String getNewTemplatePath()

For action with a type of ContentTestActionType.CHANGE_TEMPLATE_PATH, returns the value of the new template path.

Returns:

setNewTemplatePath

void setNewTemplatePath(String newPath)

For action with a type of ContentTestActionType.CHANGE_TEMPLATE_PATH, sets the value of the new template path.

Parameters:

newPath -

getNewSystemProperty

org.broadleafcommerce.common.config.domain.SystemProperty getNewSystemProperty()

For action with a type of ContentTestActionType.CHANGE_VARIABLE, returns the SystemProperty whose value should be changed to the value of getNewPropertyValue()

setNewSystemProperty

void setNewSystemProperty(org.broadleafcommerce.common.config.domain.SystemProperty property)

For action with a type of ContentTestActionType.CHANGE_VARIABLE, sets the SystemProperty whose value should be changed to the value of getNewPropertyValue()

Parameters:

property -

getNewPropertyValue

String getNewPropertyValue()

For action with a type of ContentTestActionType.CHANGE_VARIABLE, returns the value of the new template path.

Returns:

setNewPropertyValue

void setNewPropertyValue(String newValue)

For action with a type of ContentTestActionType.CHANGE_VARIABLE, sets the value of the new template path.

Parameters:

newValue -

getNewUrl

String getNewUrl()

For action with a type of ContentTestActionType.CHANGE_URL, returns the value of the new url.

Returns:

setNewUrl

void setNewUrl(String newUrl)

For action with a type of ContentTestActionType.CHANGE_URL, sets the value of the new url.

Parameters:

newUrl -

getPriorityContent

org.broadleafcommerce.cms.structure.domain.StructuredContent getPriorityContent()

Returns the associated structured content item. For action types of ContentTestActionType.CHANGE_CONTENT_PRIORITY

Returns:

setPriorityContent

void setPriorityContent(org.broadleafcommerce.cms.structure.domain.StructuredContent priorityContent)

Sets the associated structured content item.

Parameters:

priorityContent -

getNewPriority

Integer getNewPriority()

Returns the new priority for an item of type ContentTestActionType.CHANGE_CONTENT_PRIORITY

Returns:

setNewPriority

void setNewPriority(Integer priority)

Sets the new priority for an item of type ContentTestActionType.CHANGE_CONTENT_PRIORITY

Parameters:

priority -

getRequestContextAttribute

String getRequestContextAttribute()

Returns the name of the selected price list for an action of type

Returns:

setRequestContextAttribute

void setRequestContextAttribute(String requestContextAttribute)

Sets the name of the selected price list for an action of type

Parameters:

requestContextAttribute -

getRequestContextValue

String getRequestContextValue()

Returns the value of the request context attribute

Returns:

setRequestContextValue

void setRequestContextValue(String requestContextValue)

Parameters:

requestContextValue -