Package de.hybris.platform.cms2.servicelayer.services.impl

Class DefaultCMSPageService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSPageService

de.hybris.platform.cms2.servicelayer.services.impl.DefaultCMSPageService

All Implemented Interfaces:

CMSPageService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

DefaultVendorCMSPageService

public class DefaultCMSPageService
extends AbstractCMSPageService
implements CMSPageService

Default implementation of CMSPageService interface.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.log4j.Logger	LOG

Fields inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

CURRENTCATALOGVERSION, CURRENTSITE

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultCMSPageService()

Method Summary

Modifier and Type	Method	Description
protected List<ContentSlotModel>	appendContentSlots(List<ContentSlotData> contentSlots, List<String> positions, Collection<ContentSlotForTemplateModel> templateSlots, AbstractPageModel page)
SearchPageData<AbstractPageModel>	findAllPages(String typeCode, SearchPageData searchPageData)	Find all pages.
protected CMSAdminSiteService	getAdminSiteService()
Collection<PageTemplateModel>	getAllActivePageTemplates()	Gets the all active page templates.
Collection<ContentPageModel>	getAllContentPages()	Deprecated, for removal: This API element is subject to removal in a future version.
protected Collection<ContentSlotData>	getAllContentSlotsForPageAndSlots(AbstractPageModel page, Collection<ContentSlotForPageModel> pageSlots, Collection<ContentSlotForTemplateModel> templateSlots)	Returns a list of ContentSlotData for a provided page, list of ContentSlotForPageModel and ContentSlotForTemplateModel.
protected CatalogService	getCatalogService()
protected CategoryService	getCategoryService()
List<ContentSlotForTemplateModel>	getChildSlotForTemplateAtSamePosition(Collection<ContentSlotForTemplateModel> slotForTemplateModels)	For multi-country the same position may have multi slotForTemplate, this function will get the child catalogVersion of slotForTemplateModel and remove other parents slotForTemplates.
protected CatalogLevelService	getCmsCatalogLevelService()
protected Comparator<CatalogVersionModel>	getCmsCatalogVersionLevelComparator()
protected CMSCatalogVersionService	getCmsCatalogVersionService()
protected CMSContentPageService	getCmsContentPageService()
protected CMSContentSlotDao	getCmsContentSlotDao()
protected CMSDataFactory	getCmsDataFactory()
protected CMSPageTemplateDao	getCmsPageTemplateDao()
protected ConfigurationService	getConfigurationService()
ContentSlotData	getContentSlotForPage(AbstractPageModel page, String position)	Returns a contentslot for the given page and position.
ContentSlotData	getContentSlotForPage(AbstractPageModel page, String position, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, no longer needed.
Collection<ContentSlotForPageModel>	getContentSlotModelsForPage(AbstractPageModel page, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, no longer needed.
Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page)	Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for passed as parameter AbstractPageModel object.
Collection<ContentSlotData>	getContentSlotsForPage(AbstractPageModel page, PagePreviewCriteriaData pagePreviewCriteria)	Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for a given AbstractPageModel and PagePreviewCriteriaData.
Collection<ContentSlotForTemplateModel>	getContentSlotsForPageTemplate(PageTemplateModel pageTemplate)	Gets all ContentSlotForTemplateModel objects related to passed as parameter PageTemplateModel.
protected Collection<ContentSlotData>	getContentSlotsForPageVersionFromSessionContext(AbstractPageModel page)
CatalogPageModel	getDefaultCatalogPage()	Returns the default catalog page WITHOUT evaluating any restrictions
CategoryPageModel	getDefaultCategoryPage()	Returns the default category page WITHOUT evaluating any restrictions
protected AbstractPageModel	getDefaultPage(String composedTypeCode)
ContentPageModel	getDefaultPageForLabel(String label, CatalogVersionModel version)	Deprecated, for removal: This API element is subject to removal in a future version.
ProductPageModel	getDefaultProductPage()	Returns the default product page WITHOUT evaluating any restrictions
String	getFrontendTemplateName(PageTemplateModel template)	Gets the frontend template name for PageTemplateModel object.
ContentPageModel	getHomepage()	Deprecated, for removal: This API element is subject to removal in a future version.
ContentPageModel	getHomepage(PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLabelOrId(ContentPageModel contentPage)	Deprecated, for removal: This API element is subject to removal in a future version.
protected Optional<ContentSlotModel>	getOverrideSlot(List<ContentSlotModel> contentSlots, ContentSlotModel contentSlot)
Collection<ContentSlotForPageModel>	getOwnContentSlotsForPage(AbstractPageModel page)	Returns the ContentSlotForPageModel objects for passed as parameter AbstractPageModel object.
protected ContentSlotData	getPageContentSlotFromVersionSessionContext(String position)	Return the Content Slot Data for a given page associated by the version in the session context and position.
CatalogPageModel	getPageForCatalog(CatalogModel catalog)	Gets the page by catalog.
CatalogPageModel	getPageForCatalogId(String catalogId)	Gets the page for catalog id.
CategoryPageModel	getPageForCategory(CategoryModel category)	Gets the page for category.
CategoryPageModel	getPageForCategory(CategoryModel category, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for category and PagePreviewCriteriaData.
CategoryPageModel	getPageForCategoryCode(String categoryCode)	Gets the page for category code.
CategoryPageModel	getPageForCategoryCode(String categoryCode, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for category code and PagePreviewCriteriaData.
AbstractPageModel	getPageForId(String id)	Returns the page associated to a given uid.
AbstractPageModel	getPageForId(String id, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for id and PagePreviewCriteriaData.
AbstractPageModel	getPageForIdWithRestrictions(String id)	Deprecated, for removal: This API element is subject to removal in a future version.
ContentPageModel	getPageForLabel(String label)	Deprecated, for removal: This API element is subject to removal in a future version.
ContentPageModel	getPageForLabel(String label, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version.
ContentPageModel	getPageForLabelAndPageStatuses(String label, List<CmsPageStatus> pageStatuses)	Deprecated, for removal: This API element is subject to removal in a future version.
ContentPageModel	getPageForLabelOrId(String labelOrId)	Deprecated, for removal: This API element is subject to removal in a future version.
ContentPageModel	getPageForLabelOrId(String labelOrId, PagePreviewCriteriaData pagePreviewCriteria)	Deprecated, for removal: This API element is subject to removal in a future version.
ProductPageModel	getPageForProduct(ProductModel product)	Gets the page for product.
ProductPageModel	getPageForProduct(ProductModel product, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for product and PagePreviewCriteriaData.
ProductPageModel	getPageForProductCode(String productCode)	Gets the page for product code.
ProductPageModel	getPageForProductCode(String productCode, PagePreviewCriteriaData pagePreviewCriteria)	Gets the page for product code and PagePreviewCriteriaData.
Collection<AbstractPageModel>	getPagesForComponent(AbstractCMSComponentModel component)	Returns all pages where given component occurs.
Collection<AbstractPageModel>	getPagesForContentSlots(Collection<ContentSlotModel> contentSlots)	Returns all pages where given content slots occurs.
Collection<AbstractPageModel>	getPagesForPageTemplateComponent(AbstractCMSComponentModel component)	Gets the pages for page template component.
Collection<AbstractPageModel>	getPagesForPageTemplateContentSlots(Collection<ContentSlotModel> contentSlots)	Gets the pages for page template content slots.
protected Collection<ContentSlotForTemplateModel>	getPageTemplateSlots(AbstractPageModel page)	Returns a list of ContentSlotForTemplateModel for a given page.
protected ProductService	getProductService()
protected AbstractPageModel	getSinglePage(String composedTypeCode)
List<ContentSlotModel>	getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots, List<CatalogVersionModel> catalogVersions)	Gets the content slots sorted by their catalog hierarchy.
List<ContentSlotModel>	getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots, List<CatalogVersionModel> catalogVersions, AbstractPageModel page)	Gets the content slots sorted by their catalog hierarchy.
protected TypeService	getTypeService()
void	setAdminSiteService(CMSAdminSiteService adminSiteService)
void	setCatalogService(CatalogService catalogService)
void	setCategoryService(CategoryService categoryService)
void	setCmsCatalogLevelService(CatalogLevelService cmsCatalogLevelService)
void	setCmsCatalogVersionLevelComparator(Comparator<CatalogVersionModel> cmsCatalogVersionLevelComparator)
void	setCmsCatalogVersionService(CMSCatalogVersionService cmsCatalogVersionService)
void	setCmsContentPageService(CMSContentPageService cmsContentPageService)
void	setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)
void	setCmsDataFactory(CMSDataFactory cmsDataFactory)
void	setCmsPageTemplateDao(CMSPageTemplateDao cmsPageTemplateDao)
void	setConfigurationService(ConfigurationService configurationService)
void	setProductService(ProductService productService)
void	setTypeService(TypeService typeService)

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSPageService

getCatalogVersionService, getCmsItemCatalogLevelComparator, getCmsPageDao, getCmsRestrictionService, getCmsVersionDao, getCmsVersionService, getCmsVersionSessionContextProvider, getItemByCriteria, getPageForVersionUid, getSessionSearchRestrictionsDisabler, setCatalogVersionService, setCmsItemCatalogLevelComparator, setCmsPageDao, setCmsRestrictionService, setCmsVersionDao, setCmsVersionService, setCmsVersionSessionContextProvider, setSessionSearchRestrictionsDisabler

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

getBaseSiteService, getCurrentCatalogVersion, getCurrentSite, getSearchRestrictionService, getUserService, setBaseSiteService, setSearchRestrictionService, setUserService

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

protected static final org.apache.log4j.Logger LOG

Constructor Details

DefaultCMSPageService

public DefaultCMSPageService()

Method Details

getAllActivePageTemplates

public Collection<PageTemplateModel> getAllActivePageTemplates()

Description copied from interface: CMSPageService

Gets the all active page templates.

Specified by:

getAllActivePageTemplates in interface CMSPageService

Returns:

the all active page templates

getAllContentPages

@Deprecated(since="1905",
            forRemoval=true)
public Collection<ContentPageModel> getAllContentPages()

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the all content pages.

Specified by:

getAllContentPages in interface CMSPageService

Returns:

the all content pages

getOwnContentSlotsForPage

public Collection<ContentSlotForPageModel> getOwnContentSlotsForPage(AbstractPageModel page)

Description copied from interface: CMSPageService

Returns the ContentSlotForPageModel objects for passed as parameter AbstractPageModel object.

Specified by:

getOwnContentSlotsForPage in interface CMSPageService

Parameters:

page - the AbstractPageModel object.

Returns:

collection of ContentSlotForPageModel objects related to AbstractPageModel.

getContentSlotModelsForPage

@Deprecated(since="2105",
            forRemoval=true)
public Collection<ContentSlotForPageModel> getContentSlotModelsForPage(AbstractPageModel page,
 PagePreviewCriteriaData pagePreviewCriteria)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, no longer needed.

Description copied from interface: CMSPageService

Returns the ContentSlotForPageModel objects for passed as parameter AbstractPageModel object and PagePreviewCriteriaData.

Specified by:

getContentSlotModelsForPage in interface CMSPageService

Parameters:

page - the AbstractPageModel object.

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

collection of ContentSlotForPageModel objects related to AbstractPageModel.

getContentSlotForPage

public ContentSlotData getContentSlotForPage(AbstractPageModel page,
 String position)
                                      throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Returns a contentslot for the given page and position. WARNING: This could be a performance issue when you select all content slots of a page via this method. A better way is to set all contentslots via getContentSlotsForPage(AbstractPageModel page) and set them in the request scope

Specified by:

getContentSlotForPage in interface CMSPageService

Parameters:

page - the page model

position - the position

Returns:

contentslot for the given page and position.

Throws:

CMSItemNotFoundException - if no content slot is defined at this position in that page

getContentSlotForPage

@Deprecated(since="2105",
            forRemoval=true)
public ContentSlotData getContentSlotForPage(AbstractPageModel page,
 String position,
 PagePreviewCriteriaData pagePreviewCriteria)
                                      throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, no longer needed.

Description copied from interface: CMSPageService

Returns a contentslot for the given page, position and PagePreviewCriteriaData. WARNING: This could be a performance issue when you select all content slots of a page via this method. A better way is to set all contentslots via getContentSlotsForPage(AbstractPageModel page) and set them in the request scope

Specified by:

getContentSlotForPage in interface CMSPageService

Parameters:

page - the page model

position - the position

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

contentslot for the given page and position.

Throws:

CMSItemNotFoundException - if no content slot is defined at this position in that page

getContentSlotsForPage

public Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page)

Description copied from interface: CMSPageService

Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for passed as parameter AbstractPageModel object.

Specified by:

getContentSlotsForPage in interface CMSPageService

Parameters:

page - the AbstractPageModel object.

Returns:

collection of ContentSlotData objects.

getAllContentSlotsForPageAndSlots

protected Collection<ContentSlotData> getAllContentSlotsForPageAndSlots(AbstractPageModel page,
 Collection<ContentSlotForPageModel> pageSlots,
 Collection<ContentSlotForTemplateModel> templateSlots)

Returns a list of ContentSlotData for a provided page, list of ContentSlotForPageModel and ContentSlotForTemplateModel.

Parameters:

page - the page model

pageSlots - the list of ContentSlotForPageModel

templateSlots - the list of ContentSlotForTemplateModel

Returns:

list of content slot dto

getChildSlotForTemplateAtSamePosition

public List<ContentSlotForTemplateModel> getChildSlotForTemplateAtSamePosition(Collection<ContentSlotForTemplateModel> slotForTemplateModels)

For multi-country the same position may have multi slotForTemplate, this function will get the child catalogVersion of slotForTemplateModel and remove other parents slotForTemplates.

Specified by:

getChildSlotForTemplateAtSamePosition in interface CMSPageService

Parameters:

slotForTemplateModels - the list of ContentSlotForTemplateModel may have multi slotForTemplate in same position

Returns:

the ContentSlotForTemplateModel

getPageTemplateSlots

protected Collection<ContentSlotForTemplateModel> getPageTemplateSlots(AbstractPageModel page)

Returns a list of ContentSlotForTemplateModel for a given page.

getContentSlotsForPage

public Collection<ContentSlotData> getContentSlotsForPage(AbstractPageModel page,
 PagePreviewCriteriaData pagePreviewCriteria)

Description copied from interface: CMSPageService

Returns collection of ContentSlotData objects containing data taken from all ContentSlotForPageModel objects as well from ContentSlotForTemplateModel objects for a given AbstractPageModel and PagePreviewCriteriaData.

Specified by:

getContentSlotsForPage in interface CMSPageService

Parameters:

page - the AbstractPageModel object.

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

collection of ContentSlotData objects.

getContentSlotsForPageVersionFromSessionContext

protected Collection<ContentSlotData> getContentSlotsForPageVersionFromSessionContext(AbstractPageModel page)
                                                                               throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getOverrideSlot

protected Optional<ContentSlotModel> getOverrideSlot(List<ContentSlotModel> contentSlots,
 ContentSlotModel contentSlot)

getSortedMultiCountryContentSlots

public List<ContentSlotModel> getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots,
 List<CatalogVersionModel> catalogVersions)

Description copied from interface: CMSPageService

Gets the content slots sorted by their catalog hierarchy.

Specified by:

getSortedMultiCountryContentSlots in interface CMSPageService

Parameters:

contentSlots - - the content slots

catalogVersions - - the catalog versions

Returns:

a sorted list of content slots

getSortedMultiCountryContentSlots

public List<ContentSlotModel> getSortedMultiCountryContentSlots(List<ContentSlotModel> contentSlots,
 List<CatalogVersionModel> catalogVersions,
 AbstractPageModel page)

Description copied from interface: CMSPageService

Gets the content slots sorted by their catalog hierarchy.

Specified by:

getSortedMultiCountryContentSlots in interface CMSPageService

Parameters:

contentSlots - - the content slots

catalogVersions - - the catalog versions

page - - original page

Returns:

a sorted list of ContentSlotModel, empty list of not found.

appendContentSlots

protected List<ContentSlotModel> appendContentSlots(List<ContentSlotData> contentSlots,
 List<String> positions,
 Collection<ContentSlotForTemplateModel> templateSlots,
 AbstractPageModel page)

getContentSlotsForPageTemplate

public Collection<ContentSlotForTemplateModel> getContentSlotsForPageTemplate(PageTemplateModel pageTemplate)

Description copied from interface: CMSPageService

Gets all ContentSlotForTemplateModel objects related to passed as parameter PageTemplateModel.

Specified by:

getContentSlotsForPageTemplate in interface CMSPageService

Parameters:

pageTemplate - the PageTemplateModel object for which search will be executed.

Returns:

the list of found ContentSlotForTemplateModel objects.

getDefaultCatalogPage

public CatalogPageModel getDefaultCatalogPage()
                                       throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Returns the default catalog page WITHOUT evaluating any restrictions

Specified by:

getDefaultCatalogPage in interface CMSPageService

Returns:

default catalog page

Throws:

CMSItemNotFoundException - if no default catalog page could be found

getDefaultCategoryPage

public CategoryPageModel getDefaultCategoryPage()
                                         throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Returns the default category page WITHOUT evaluating any restrictions

Specified by:

getDefaultCategoryPage in interface CMSPageService

Returns:

default category page

Throws:

CMSItemNotFoundException - if no default category page could be found

getDefaultPageForLabel

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getDefaultPageForLabel(String label,
 CatalogVersionModel version)
                                        throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the default page by label and catalog version.

Specified by:

getDefaultPageForLabel in interface CMSPageService

Parameters:

label - the label

version - the version

Returns:

the default page by label

Throws:

CMSItemNotFoundException - thrown when item was not found

getDefaultProductPage

public ProductPageModel getDefaultProductPage()
                                       throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Returns the default product page WITHOUT evaluating any restrictions

Specified by:

getDefaultProductPage in interface CMSPageService

Returns:

default product page

Throws:

CMSItemNotFoundException - if no default product page could be found

getFrontendTemplateName

public String getFrontendTemplateName(PageTemplateModel template)

Description copied from interface: CMSPageService

Gets the frontend template name for PageTemplateModel object.

Specified by:

getFrontendTemplateName in interface CMSPageService

Parameters:

template - the PageTemplateModel object.

Returns:

the frontend template name.

getHomepage

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getHomepage()

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the homepage by finding all content pages having ContentPageModel#isHomepage() equals TRUE, in all the catalog versions saved in the session.
In the multi-country scenario, the list of catalog versions contains the catalog versions hierarchy for the active site.

CMS restrictions will be evaluated on the homepage to ensure that the proper primary or variation page is returned.

Specified by:

getHomepage in interface CMSPageService

Returns:

the homepage model

getHomepage

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getHomepage(PagePreviewCriteriaData pagePreviewCriteria)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns homepage for PagePreviewCriteriaData.

Specified by:

getHomepage in interface CMSPageService

Parameters:

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the homepage model

getLabelOrId

@Deprecated(since="1905",
            forRemoval=true)
public String getLabelOrId(ContentPageModel contentPage)

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the ContentPageModel label or id if label is empty.

Specified by:

getLabelOrId in interface CMSPageService

Parameters:

contentPage - the ContentPageModel object.

Returns:

the label or id of ContentPageModel.

getPageForCatalog

public CatalogPageModel getPageForCatalog(CatalogModel catalog)
                                   throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page by catalog.

Specified by:

getPageForCatalog in interface CMSPageService

Parameters:

catalog - the catalog

Returns:

the page by catalog

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCatalogId

public CatalogPageModel getPageForCatalogId(String catalogId)
                                     throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for catalog id.

Specified by:

getPageForCatalogId in interface CMSPageService

Parameters:

catalogId - the catalog id

Returns:

the page for catalog id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCategory

public CategoryPageModel getPageForCategory(CategoryModel category)
                                     throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for category.

Specified by:

getPageForCategory in interface CMSPageService

Parameters:

category - the category

Returns:

the page for category

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCategory

public CategoryPageModel getPageForCategory(CategoryModel category,
 PagePreviewCriteriaData pagePreviewCriteria)
                                     throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for category and PagePreviewCriteriaData.

Specified by:

getPageForCategory in interface CMSPageService

Parameters:

category - the category

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for category

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForCategoryCode

public CategoryPageModel getPageForCategoryCode(String categoryCode)
                                         throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for category code.

Specified by:

getPageForCategoryCode in interface CMSPageService

Parameters:

categoryCode - the category code

Returns:

the page for category code

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForCategoryCode

public CategoryPageModel getPageForCategoryCode(String categoryCode,
 PagePreviewCriteriaData pagePreviewCriteria)
                                         throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for category code and PagePreviewCriteriaData.

Specified by:

getPageForCategoryCode in interface CMSPageService

Parameters:

categoryCode - the category code

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for category code

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForId

public AbstractPageModel getPageForId(String id)
                               throws CMSItemNotFoundException

Description copied from class: AbstractCMSPageService

Returns the page associated to a given uid.

Specified by:

getPageForId in interface CMSPageService

Overrides:

getPageForId in class AbstractCMSPageService

Parameters:

id - the page id

Returns:

the page matching the provided uid

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForIdWithRestrictions

@Deprecated(since="1905",
            forRemoval=true)
public AbstractPageModel getPageForIdWithRestrictions(String id)
                                               throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the page for id and evaluates the page restrictions

Specified by:

getPageForIdWithRestrictions in interface CMSPageService

Parameters:

id - the id

Returns:

the page for id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForId

public AbstractPageModel getPageForId(String id,
 PagePreviewCriteriaData pagePreviewCriteria)
                               throws CMSItemNotFoundException

Gets the page for id and PagePreviewCriteriaData.

Specified by:

getPageForId in interface CMSPageService

Parameters:

id - the id

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for id

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForLabel

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getPageForLabel(String label)
                                 throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the page for label.

Specified by:

getPageForLabel in interface CMSPageService

Parameters:

label - the label

Returns:

the page for label

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForLabel

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getPageForLabel(String label,
 PagePreviewCriteriaData pagePreviewCriteria)
                                 throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the page for label and PagePreviewCriteriaData.

Specified by:

getPageForLabel in interface CMSPageService

Parameters:

label - the label

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for label

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForLabelAndPageStatuses

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getPageForLabelAndPageStatuses(String label,
 List<CmsPageStatus> pageStatuses)
                                                throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the page for label by page status.

Specified by:

getPageForLabelAndPageStatuses in interface CMSPageService

Parameters:

label - the label

pageStatuses - the page statuses. i.e. (deleted, active)

Returns:

the page for label

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForLabelOrId

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getPageForLabelOrId(String labelOrId)
                                     throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the page for label or id.

Specified by:

getPageForLabelOrId in interface CMSPageService

Parameters:

labelOrId - the label or id

Returns:

the page for label or id

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForLabelOrId

@Deprecated(since="1905",
            forRemoval=true)
public ContentPageModel getPageForLabelOrId(String labelOrId,
 PagePreviewCriteriaData pagePreviewCriteria)
                                     throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the page for label or id and PagePreviewCriteriaData.

Specified by:

getPageForLabelOrId in interface CMSPageService

Parameters:

labelOrId - the label or id

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for label or id

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForProduct

public ProductPageModel getPageForProduct(ProductModel product)
                                   throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for product.

Specified by:

getPageForProduct in interface CMSPageService

Parameters:

product - the product

Returns:

the page for product

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForProduct

public ProductPageModel getPageForProduct(ProductModel product,
 PagePreviewCriteriaData pagePreviewCriteria)
                                   throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for product and PagePreviewCriteriaData.

Specified by:

getPageForProduct in interface CMSPageService

Parameters:

product - the product

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for product

Throws:

CMSItemNotFoundException - thrown when item is not found

getPageForProductCode

public ProductPageModel getPageForProductCode(String productCode)
                                       throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for product code.

Specified by:

getPageForProductCode in interface CMSPageService

Parameters:

productCode - the product code

Returns:

the page for product code

Throws:

CMSItemNotFoundException - thrown when item was not found

getPageForProductCode

public ProductPageModel getPageForProductCode(String productCode,
 PagePreviewCriteriaData pagePreviewCriteria)
                                       throws CMSItemNotFoundException

Description copied from interface: CMSPageService

Gets the page for product code and PagePreviewCriteriaData.

Specified by:

getPageForProductCode in interface CMSPageService

Parameters:

productCode - the product code

pagePreviewCriteria - the PagePreviewCriteriaData object.

Returns:

the page for product code

Throws:

CMSItemNotFoundException - thrown when item is not found

getPagesForComponent

public Collection<AbstractPageModel> getPagesForComponent(AbstractCMSComponentModel component)

Description copied from interface: CMSPageService

Returns all pages where given component occurs.

Specified by:

getPagesForComponent in interface CMSPageService

Parameters:

component - - component model that we are looking pages for

Returns:

- collection of AbstractPageModel

getPagesForContentSlots

public Collection<AbstractPageModel> getPagesForContentSlots(Collection<ContentSlotModel> contentSlots)

Description copied from interface: CMSPageService

Returns all pages where given content slots occurs.

Specified by:

getPagesForContentSlots in interface CMSPageService

Parameters:

contentSlots - - content slot model that we are looking pages for

Returns:

- collection of AbstractPageModel

getPagesForPageTemplateComponent

public Collection<AbstractPageModel> getPagesForPageTemplateComponent(AbstractCMSComponentModel component)

Description copied from interface: CMSPageService

Gets the pages for page template component.

Specified by:

getPagesForPageTemplateComponent in interface CMSPageService

Parameters:

component - the component

Returns:

the pages for page template component

getPagesForPageTemplateContentSlots

public Collection<AbstractPageModel> getPagesForPageTemplateContentSlots(Collection<ContentSlotModel> contentSlots)

Description copied from interface: CMSPageService

Gets the pages for page template content slots.

Specified by:

getPagesForPageTemplateContentSlots in interface CMSPageService

Parameters:

contentSlots - the content slots

Returns:

the pages for page template content slots

getDefaultPage

protected AbstractPageModel getDefaultPage(String composedTypeCode)
                                    throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getSinglePage

protected AbstractPageModel getSinglePage(String composedTypeCode)

getPageContentSlotFromVersionSessionContext

protected ContentSlotData getPageContentSlotFromVersionSessionContext(String position)
                                                               throws CMSItemNotFoundException

Return the Content Slot Data for a given page associated by the version in the session context and position.

Parameters:

position - the position of the slot in the page.

Returns:

ContentSlotData the ContentSlotData data.

Throws:

CMSItemNotFoundException

findAllPages

public SearchPageData<AbstractPageModel> findAllPages(String typeCode,
 SearchPageData searchPageData)

Description copied from interface: CMSPageService

Find all pages. The result is paginated.

Specified by:

findAllPages in interface CMSPageService

Parameters:

typeCode - the page type code

searchPageData - the pagination and sorting information

Returns:

a search result containing a list of AbstractPageModel; can be empty, never NULL

getCatalogService

protected CatalogService getCatalogService()

setCatalogService

public void setCatalogService(CatalogService catalogService)

getCategoryService

protected CategoryService getCategoryService()

setCategoryService

public void setCategoryService(CategoryService categoryService)

setCmsContentSlotDao

public void setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)

getCmsContentSlotDao

protected CMSContentSlotDao getCmsContentSlotDao()

setCmsDataFactory

public void setCmsDataFactory(CMSDataFactory cmsDataFactory)

getCmsDataFactory

protected CMSDataFactory getCmsDataFactory()

getCmsContentPageService

protected CMSContentPageService getCmsContentPageService()

setCmsContentPageService

public void setCmsContentPageService(CMSContentPageService cmsContentPageService)

getCmsPageTemplateDao

protected CMSPageTemplateDao getCmsPageTemplateDao()

setCmsPageTemplateDao

public void setCmsPageTemplateDao(CMSPageTemplateDao cmsPageTemplateDao)

getProductService

protected ProductService getProductService()

setProductService

public void setProductService(ProductService productService)

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getCmsCatalogLevelService

protected CatalogLevelService getCmsCatalogLevelService()

setCmsCatalogLevelService

public void setCmsCatalogLevelService(CatalogLevelService cmsCatalogLevelService)

getAdminSiteService

protected CMSAdminSiteService getAdminSiteService()

setAdminSiteService

public void setAdminSiteService(CMSAdminSiteService adminSiteService)

getCmsCatalogVersionLevelComparator

protected Comparator<CatalogVersionModel> getCmsCatalogVersionLevelComparator()

setCmsCatalogVersionLevelComparator

public void setCmsCatalogVersionLevelComparator(Comparator<CatalogVersionModel> cmsCatalogVersionLevelComparator)

getCmsCatalogVersionService

protected CMSCatalogVersionService getCmsCatalogVersionService()

setCmsCatalogVersionService

public void setCmsCatalogVersionService(CMSCatalogVersionService cmsCatalogVersionService)