com.broadleafcommerce.advancedcms.service

Interface ContentZoneService

All Known Implementing Classes:

ContentZoneServiceImpl

public interface ContentZoneService

Service methods for ContentZones

Author:

Andre Azzolini (apazzolini)

Method Summary

Methods

Modifier and Type	Method and Description
List<ContentZone>	findAllContentZonesUsingDefinition(ContentZoneDefinition contentZoneDefinition)
ContentItemDTO	findContentItemDTOForZoneName(String name, boolean secure) Returns the ContentItemDTO associated with the given zone name
ContentItemDTO	findContentItemDTOForZoneName(String name, boolean secure, Map<String,Object> args) Returns the ContentItemDTO associated with the given zone name and extra arguments.
ContentZone	findContentZoneById(Long id)
ContentZone	findContentZoneByName(String name) Returns the ContentZone associated with the given name
ContentZoneDefinition	findContentZoneDefinitionById(Long id)
List<ContentZoneDefinition>	findContentZoneDefinitionsAllowingWidget(Widget widget)
boolean	removeStructuredContentDTOsFromCache(ContentItem contentItem) Call to evict a DTOList from the cache.
ContentZone	saveContentZone(ContentZone contentZone) Saves the given ContentZone and returns the saved version

Method Detail

findContentZoneByName

ContentZone findContentZoneByName(String name)

Returns the ContentZone associated with the given name

Parameters:

name -

Returns:

the ContentZone

findContentItemDTOForZoneName

ContentItemDTO findContentItemDTOForZoneName(String name,
                                           boolean secure)

Returns the ContentItemDTO associated with the given zone name

Parameters:

name -

secure - Some ContentItems contain HTML with URLs that must be modified based on HTTP or HTTPS

Returns:

the ContentItemDTO

findContentItemDTOForZoneName

ContentItemDTO findContentItemDTOForZoneName(String name,
                                           boolean secure,
                                           Map<String,Object> args)

Returns the ContentItemDTO associated with the given zone name and extra arguments.

Parameters:

name -

secure - Some ContentItems contain HTML with URLs that must be modified based on HTTP or HTTPS

args - - additional arguments that an implementation might want to use to more specifically find a ContentItem

Returns:

the ContentItemDTO

saveContentZone

ContentZone saveContentZone(ContentZone contentZone)

Saves the given ContentZone and returns the saved version

Parameters:

name -

Returns:

the saved ContentZone

findContentZoneDefinitionsAllowingWidget

List<ContentZoneDefinition> findContentZoneDefinitionsAllowingWidget(Widget widget)

Parameters:

widget -

Returns:

a list of ContentZoneDefinitions that allow the given Widget

findAllContentZonesUsingDefinition

List<ContentZone> findAllContentZonesUsingDefinition(ContentZoneDefinition contentZoneDefinition)

Parameters:

contentZoneDefinition -

Returns:

a list of ContentZones that are using the given ContentZoneDefinition

findContentZoneDefinitionById

ContentZoneDefinition findContentZoneDefinitionById(Long id)

Parameters:

id -

Returns:

the ContentZoneDefinition matching the given id

findContentZoneById

ContentZone findContentZoneById(Long id)

Parameters:

id -

Returns:

the ContentZone matching the given id

removeStructuredContentDTOsFromCache

boolean removeStructuredContentDTOsFromCache(ContentItem contentItem)

Call to evict a DTOList from the cache.

Parameters:

contentItemDto -

Returns:

whether remove was successful