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

Class DefaultCMSAdminPageService

java.lang.Object

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

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

de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

de.hybris.platform.cms2.servicelayer.services.admin.impl.DefaultCMSAdminPageService

All Implemented Interfaces:

CMSAdminPageService, Serializable

public class DefaultCMSAdminPageService
extends AbstractCMSAdminService
implements CMSAdminPageService

Default implementation of the page service.

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 and Description
CMSPageDao	cmsPageDao Deprecated. Implement the CMSPageDao as own property
CMSPageTemplateDao	cmsPageTemplateDao Deprecated. Implement the CMSPageTemplateDao as own property
protected TypeService	typeService Deprecated. Implement the TypeService as own property

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

ACTIVECATALOGVERSION, ACTIVESITE

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 and Description
DefaultCMSAdminPageService()

Method Summary

Modifier and Type	Method and Description
CategoryPageModel	createCategoryPage(String id, String name, String masterTemplateId, boolean isDefault) Creates the category page.
ContentPageModel	createContentPage(String id, String name, String masterTemplateId, String label) Creates the content page.
AbstractPageModel	createPage(String composedType, String id, String name, String masterTemplateId) Creates the page.
protected AbstractPageModel	createPageFromType(String composedTypeCode)
ProductPageModel	createProductPage(String id, String name, String masterTemplateId, boolean isDefault) Creates the product page.
void	deletePage(String id) Delete a page from the active catalog version
Collection<AbstractPageModel>	findPagesByType(ComposedTypeModel composedType, boolean isDefault) Gets the all default or non-default pages by page type from the active catalog version.
Collection<PageTemplateModel>	getAllActivePageTemplates() returns all page templates which are set to active (only of the active catalogVersion)
Collection<ContentPageModel>	getAllContentPages(Collection<CatalogVersionModel> catalogVersions) Gets the all content pages.
Collection<AbstractPageModel>	getAllPages() Returns all pages which are assigned to the active catalog version
Collection<AbstractPageModel>	getAllPages(CatalogVersionModel catalogVersion) Gets the all pages.
Collection<AbstractPageModel>	getAllPagesByType(String type) Returns all pages which are assigned to the active catalog version and are of the given type
Collection<AbstractPageModel>	getAllPagesByType(String type, CatalogVersionModel catalogVersion) Gets the all pages by type.
Map<String,Collection<AbstractPageModel>>	getAllPagesMap() returns all pages of the active catalogVersion.
Collection<PageTemplateModel>	getAllPageTemplates(boolean active) returns all page templates (only of the active catalogVersion)
Collection<PageTemplateModel>	getAllPageTemplates(Collection<CatalogVersionModel> catalogVersions) Gets the all page templates.
Collection<CMSPageTypeModel>	getAllPageTypes() Returns a collection of all available page types.
Collection<PageTemplateModel>	getAllRestrictedPageTemplates(boolean active, CMSPageTypeModel type) returns all restricted page templates (only of the active catalogVersion)
Collection<ContentPageModel>	getContentPages(Collection<CatalogVersionModel> catalogVersions, String label) Gets the content pages.
ContentPageModel	getHomepage(CMSSiteModel siteModel) Gets the homepage for a given CMS Site.
AbstractPageModel	getPageById(String id) Deprecated. use getPageForIdFromActiveCatalogVersion(String) instead.
AbstractPageModel	getPageForIdFromActiveCatalogVersion(String id) Returns the page with the given id from active catalogVersion.
PageTemplateModel	getPageTemplateById(String id) Deprecated. use getPageTemplateForIdFromActiveCatalogVersion(String) instead.
PageTemplateModel	getPageTemplateForIdFromActiveCatalogVersion(String id) Gets the page template with the give id.
Optional<CMSPageTypeModel>	getPageTypeByCode(String typeCode) Returns the page type with the given type code.
boolean	pageExists(String id) Checks if a page exists in the active catalog version
void	save(AbstractPageModel page) Deprecated.
void	setCmsPageDao(CMSPageDao cmsPageDao)
void	setCmsPageTemplateDao(CMSPageTemplateDao cmsPageTemplateDao)
void	setTypeService(TypeService typeService)
void	updatePage(AbstractPageModel page, String name, String masterTemplateId) Updates the given page.

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

getActiveCatalogVersion, getActiveSite, getUserService, 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, setTenantScope, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.cms2.servicelayer.services.admin.CMSAdminPageService

getActiveCatalogVersion

Field Detail

cmsPageDao

@Deprecated
public CMSPageDao cmsPageDao

Deprecated. Implement the CMSPageDao as own property

cmsPageTemplateDao

@Deprecated
public CMSPageTemplateDao cmsPageTemplateDao

Deprecated. Implement the CMSPageTemplateDao as own property

typeService

@Deprecated
protected TypeService typeService

Deprecated. Implement the TypeService as own property

Constructor Detail

DefaultCMSAdminPageService

public DefaultCMSAdminPageService()

Method Detail

createCategoryPage

public CategoryPageModel createCategoryPage(String id,
                                            String name,
                                            String masterTemplateId,
                                            boolean isDefault)
                                     throws CMSItemCreateException

Creates the category page.

Specified by:

createCategoryPage in interface CMSAdminPageService

Parameters:

id - the id

name - the name

masterTemplateId - the master template id

isDefault - the is default

Returns:

the category page model

Throws:

CMSItemCreateException - the cMS item create exception

createContentPage

public ContentPageModel createContentPage(String id,
                                          String name,
                                          String masterTemplateId,
                                          String label)
                                   throws CMSItemCreateException

Creates the content page.

Specified by:

createContentPage in interface CMSAdminPageService

Parameters:

id - the id

name - the name

masterTemplateId - the master template id

label - the label

Returns:

the content page model

Throws:

CMSItemCreateException - the cMS item create exception

createPage

public AbstractPageModel createPage(String composedType,
                                    String id,
                                    String name,
                                    String masterTemplateId)
                             throws CMSItemCreateException

Creates the page.

Specified by:

createPage in interface CMSAdminPageService

Parameters:

composedType - the composed type

id - the id

name - the name

masterTemplateId - the master template id

Returns:

the abstract page model

Throws:

CMSItemCreateException - the cMS item create exception

createProductPage

public ProductPageModel createProductPage(String id,
                                          String name,
                                          String masterTemplateId,
                                          boolean isDefault)
                                   throws CMSItemCreateException

Creates the product page.

Specified by:

createProductPage in interface CMSAdminPageService

Parameters:

id - the id

name - the name

masterTemplateId - the master template id

isDefault - the is default

Returns:

the product page model

Throws:

CMSItemCreateException - the cMS item create exception

deletePage

public void deletePage(String id)
                throws CMSItemNotFoundException

Delete a page from the active catalog version

Specified by:

deletePage in interface CMSAdminPageService

Throws:

CMSItemNotFoundException - if no page with the give id is found

getAllActivePageTemplates

public Collection<PageTemplateModel> getAllActivePageTemplates()

returns all page templates which are set to active (only of the active catalogVersion)

Specified by:

getAllActivePageTemplates in interface CMSAdminPageService

Returns:

all page templates

getAllContentPages

public Collection<ContentPageModel> getAllContentPages(Collection<CatalogVersionModel> catalogVersions)

Gets the all content pages.

Specified by:

getAllContentPages in interface CMSAdminPageService

Parameters:

catalogVersions - the catalog versions

Returns:

the all content pages

getAllPageTypes

public Collection<CMSPageTypeModel> getAllPageTypes()

Description copied from interface: CMSAdminPageService

Returns a collection of all available page types.

Specified by:

getAllPageTypes in interface CMSAdminPageService

Returns:

all page types

getPageTypeByCode

public Optional<CMSPageTypeModel> getPageTypeByCode(String typeCode)

Description copied from interface: CMSAdminPageService

Returns the page type with the given type code.

Specified by:

getPageTypeByCode in interface CMSAdminPageService

Parameters:

typeCode - the type code of the page type to retrieve

Returns:

the page type matching the given type code

getAllPages

public Collection<AbstractPageModel> getAllPages()

Returns all pages which are assigned to the active catalog version

Specified by:

getAllPages in interface CMSAdminPageService

Returns:

all pages which are assigned to the active catalog version

getAllPages

public Collection<AbstractPageModel> getAllPages(CatalogVersionModel catalogVersion)

Gets the all pages.

Specified by:

getAllPages in interface CMSAdminPageService

Parameters:

catalogVersion - the catalog version

Returns:

the all pages

getAllPagesByType

public Collection<AbstractPageModel> getAllPagesByType(String type)

Returns all pages which are assigned to the active catalog version and are of the given type

Specified by:

getAllPagesByType in interface CMSAdminPageService

Parameters:

type - should be a sub-type of AbstractPage

Returns:

all pages which are assigned to the active catalog version and are of the given type

getAllPagesByType

public Collection<AbstractPageModel> getAllPagesByType(String type,
                                                       CatalogVersionModel catalogVersion)

Gets the all pages by type.

Specified by:

getAllPagesByType in interface CMSAdminPageService

Parameters:

type - the type

catalogVersion - the catalog version

Returns:

the all pages by type

getAllPagesMap

public Map<String,Collection<AbstractPageModel>> getAllPagesMap()

returns all pages of the active catalogVersion. The pages are grouped by its type

Specified by:

getAllPagesMap in interface CMSAdminPageService

Returns:

returns all pages of the active catalogVersion. The pages are grouped by its type

getAllPageTemplates

public Collection<PageTemplateModel> getAllPageTemplates(boolean active)

returns all page templates (only of the active catalogVersion)

Specified by:

getAllPageTemplates in interface CMSAdminPageService

Parameters:

active - if set to true only page templates are returned which are set as active

Returns:

all page templates

getAllPageTemplates

public Collection<PageTemplateModel> getAllPageTemplates(Collection<CatalogVersionModel> catalogVersions)

Gets the all page templates.

Specified by:

getAllPageTemplates in interface CMSAdminPageService

Parameters:

catalogVersions - the catalog versions

Returns:

the all page templates

getAllRestrictedPageTemplates

public Collection<PageTemplateModel> getAllRestrictedPageTemplates(boolean active,
                                                                   CMSPageTypeModel type)

returns all restricted page templates (only of the active catalogVersion)

Specified by:

getAllRestrictedPageTemplates in interface CMSAdminPageService

Parameters:

active - if set to true only page templates are returned which are set as active

type - the page type to which the page template will be restricted

Returns:

all restricted page templates

getContentPages

public Collection<ContentPageModel> getContentPages(Collection<CatalogVersionModel> catalogVersions,
                                                    String label)

Gets the content pages.

Specified by:

getContentPages in interface CMSAdminPageService

Parameters:

catalogVersions - the catalog versions

label - the label

Returns:

the content pages

getPageById

@Deprecated
public AbstractPageModel getPageById(String id)
                                          throws CMSItemNotFoundException

Deprecated. use getPageForIdFromActiveCatalogVersion(String) instead.

returns the page with the given id. searches only in the active catalogVersion

Specified by:

getPageById in interface CMSAdminPageService

Parameters:

id - the id of the page

Returns:

the page for id

Throws:

CMSItemNotFoundException - if no page with the given id is found

getPageForIdFromActiveCatalogVersion

public AbstractPageModel getPageForIdFromActiveCatalogVersion(String id)
                                                       throws AmbiguousIdentifierException,
                                                              UnknownIdentifierException

Returns the page with the given id from active catalogVersion.

Specified by:

getPageForIdFromActiveCatalogVersion in interface CMSAdminPageService

Parameters:

id - the id of the page

Returns:

the page for id

Throws:

AmbiguousIdentifierException

UnknownIdentifierException

getPageTemplateById

@Deprecated
public PageTemplateModel getPageTemplateById(String id)
                                                  throws CMSItemNotFoundException

Deprecated. use getPageTemplateForIdFromActiveCatalogVersion(String) instead.

returns the page template with the give id. Searches only of the active catalogVersion

Specified by:

getPageTemplateById in interface CMSAdminPageService

Returns:

the page template for id

Throws:

CMSItemNotFoundException - if no template with the given id is found

getPageTemplateForIdFromActiveCatalogVersion

public PageTemplateModel getPageTemplateForIdFromActiveCatalogVersion(String id)
                                                               throws AmbiguousIdentifierException,
                                                                      UnknownIdentifierException

Gets the page template with the give id. Searches only of the active catalogVersion.

Specified by:

getPageTemplateForIdFromActiveCatalogVersion in interface CMSAdminPageService

Parameters:

id - the id

Returns:

found page template

Throws:

AmbiguousIdentifierException - thrown when more than one object has been found.

UnknownIdentifierException - thrown when no object has been found

pageExists

public boolean pageExists(String id)

Checks if a page exists in the active catalog version

Specified by:

pageExists in interface CMSAdminPageService

Parameters:

id - page id

Returns:

true if the page exists in the active catalog version; false otherwise

save

@Deprecated
public void save(AbstractPageModel page)

Deprecated.

Saves page model.

Specified by:

save in interface CMSAdminPageService

Parameters:

page - the page model object

setCmsPageDao

public void setCmsPageDao(CMSPageDao cmsPageDao)

setCmsPageTemplateDao

public void setCmsPageTemplateDao(CMSPageTemplateDao cmsPageTemplateDao)

setTypeService

public void setTypeService(TypeService typeService)

updatePage

public void updatePage(AbstractPageModel page,
                       String name,
                       String masterTemplateId)
                throws CMSItemNotFoundException

Updates the given page. Method explicitly saves object.

Specified by:

updatePage in interface CMSAdminPageService

Throws:

CMSItemNotFoundException

createPageFromType

protected AbstractPageModel createPageFromType(String composedTypeCode)
                                        throws CMSItemCreateException

Throws:

CMSItemCreateException

getHomepage

public ContentPageModel getHomepage(CMSSiteModel siteModel)

Description copied from interface: CMSAdminPageService

Gets the homepage for a given CMS Site.

Specified by:

getHomepage in interface CMSAdminPageService

Returns:

the homepage model

findPagesByType

public Collection<AbstractPageModel> findPagesByType(ComposedTypeModel composedType,
                                                     boolean isDefault)

Description copied from interface: CMSAdminPageService

Gets the all default or non-default pages by page type from the active catalog version.

Specified by:

findPagesByType in interface CMSAdminPageService

Parameters:

composedType - the page type model

isDefault - true to find default pages; false otherwise

Returns:

the all default or non-default pages for a given page type