com.sdl.dxa.modules.smarttarget.model.entity

Class SmartTargetRegion

java.lang.Object

com.sdl.webapp.common.api.model.AbstractViewModel

com.sdl.webapp.common.api.model.region.RegionModelImpl

com.sdl.dxa.modules.smarttarget.model.entity.SmartTargetRegion

All Implemented Interfaces:

com.sdl.webapp.common.api.formatters.support.FeedItemsProvider, com.sdl.webapp.common.api.model.CanFilterEntities, com.sdl.webapp.common.api.model.RegionModel, com.sdl.webapp.common.api.model.ViewModel

public class SmartTargetRegion
extends com.sdl.webapp.common.api.model.region.RegionModelImpl

SmartTargetRegion class.

Field Summary

Fields inherited from class com.sdl.webapp.common.api.model.region.RegionModelImpl

INCLUDED_FROM_PAGE_FILE_NAME_XPM_METADATA_KEY, INCLUDED_FROM_PAGE_ID_XPM_METADATA_KEY, INCLUDED_FROM_PAGE_TITLE_XPM_METADATA_KEY

Constructor Summary

Constructors

Constructor and Description
SmartTargetRegion(com.sdl.webapp.common.api.model.MvcData mvcData) Constructor for SmartTargetRegion.
SmartTargetRegion(com.sdl.webapp.common.api.model.RegionModel other)
SmartTargetRegion(String name) Constructor for SmartTargetRegion.
SmartTargetRegion(String name, String qualifiedViewName) Constructor for SmartTargetRegion.

Method Summary

Modifier and Type	Method and Description
SmartTargetRegion	deepCopy()
String	getStartQueryXpmMarkup() Gets the Start Query XPM markup (for staging sites).
String	getXpmMarkup(com.sdl.webapp.common.api.localization.Localization localization)

Methods inherited from class com.sdl.webapp.common.api.model.region.RegionModelImpl

addEntity, canEqual, equals, extractFeedItems, filterConditionalEntities, getEntities, getEntity, getName, getRegions, hashCode, setEntities, setName, setRegions

Methods inherited from class com.sdl.webapp.common.api.model.AbstractViewModel

addExtensionData, addXpmMetadata, collectFeedItems, getExtensionData, getHtmlClasses, getMvcData, getXpmMetadata, setExtensionData, setHtmlClasses, setMvcData, setXpmMetadata, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sdl.webapp.common.api.model.ViewModel

addExtensionData, getExtensionData, getHtmlClasses, getMvcData, getXpmMetadata, setHtmlClasses, setMvcData

Constructor Detail

SmartTargetRegion

public SmartTargetRegion(com.sdl.webapp.common.api.model.RegionModel other)

SmartTargetRegion

public SmartTargetRegion(String name)
                  throws com.sdl.webapp.common.exceptions.DxaException

Constructor for SmartTargetRegion.

Parameters:

name - a String object.

Throws:

com.sdl.webapp.common.exceptions.DxaException - if any.

SmartTargetRegion

public SmartTargetRegion(String name,
                         String qualifiedViewName)
                  throws com.sdl.webapp.common.exceptions.DxaException

Constructor for SmartTargetRegion.

Parameters:

name - a String object.

qualifiedViewName - a String object.

Throws:

com.sdl.webapp.common.exceptions.DxaException - if any.

SmartTargetRegion

public SmartTargetRegion(com.sdl.webapp.common.api.model.MvcData mvcData)
                  throws com.sdl.webapp.common.exceptions.DxaException

Constructor for SmartTargetRegion.

Parameters:

mvcData - a MvcData object.

Throws:

com.sdl.webapp.common.exceptions.DxaException - if any.

Method Detail

getStartQueryXpmMarkup

public String getStartQueryXpmMarkup()

Gets the Start Query XPM markup (for staging sites).

A SmartTarget Region has two pieces of XPM markup: a "Start Promotion Region" tag and a "Start Query" tag. The regular XPM markup mechanism (Html.DxaRegionMarkup()) renders the "Start Promotion Region" tag and this method should be called from the Region View code to render the "Start Query" tag in the right location.

Returns:

the "Start Query" XPM markup if the site is a staging site or an empty string otherwise

deepCopy

public SmartTargetRegion deepCopy()

Specified by:

deepCopy in interface com.sdl.webapp.common.api.model.RegionModel

Overrides:

deepCopy in class com.sdl.webapp.common.api.model.region.RegionModelImpl

getXpmMarkup

public String getXpmMarkup(com.sdl.webapp.common.api.localization.Localization localization)

Specified by:

getXpmMarkup in interface com.sdl.webapp.common.api.model.ViewModel

Overrides:

getXpmMarkup in class com.sdl.webapp.common.api.model.region.RegionModelImpl