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

Interface CMSAdminPageService

All Known Implementing Classes:

DefaultCMSAdminPageService

public interface CMSAdminPageService

The Interface CMSAdminPageService responsible for managing pages.

Spring Bean ID:

cmsAdminPageService

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.
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.
CatalogVersionModel	getActiveCatalogVersion() Gets 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. use ModelService.save(Object) instead.
void	updatePage(AbstractPageModel page, String name, String masterTemplateId) Updates the given page.

Method Detail

createCategoryPage

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

Creates the category page.

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

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

Creates the content page.

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

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

Creates the page.

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

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

Creates the product page.

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

void deletePage(String id)
         throws CMSItemNotFoundException

Delete a page from the active catalog version

Parameters:

id -

Throws:

CMSItemNotFoundException - if no page with the give id is found

getActiveCatalogVersion

CatalogVersionModel getActiveCatalogVersion()

Gets the active catalog version.

Returns:

the active catalog version

getAllActivePageTemplates

Collection<PageTemplateModel> getAllActivePageTemplates()

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

Returns:

all page templates

getAllContentPages

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

Gets the all content pages.

Parameters:

catalogVersions - the catalog versions

Returns:

the all content pages

getAllPageTypes

Collection<CMSPageTypeModel> getAllPageTypes()

Returns a collection of all available page types.

Returns:

all page types

getPageTypeByCode

Optional<CMSPageTypeModel> getPageTypeByCode(String typeCode)

Returns the page type with the given type code.

Parameters:

typeCode - the type code of the page type to retrieve

Returns:

the page type matching the given type code

getAllPages

Collection<AbstractPageModel> getAllPages()

Returns all pages which are assigned to the active catalog version

Returns:

all pages which are assigned to the active catalog version

getAllPages

Collection<AbstractPageModel> getAllPages(CatalogVersionModel catalogVersion)

Gets the all pages.

Parameters:

catalogVersion - the catalog version

Returns:

the all pages

getAllPagesByType

Collection<AbstractPageModel> getAllPagesByType(String type)

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

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

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

Gets the all pages by type.

Parameters:

type - the type

catalogVersion - the catalog version

Returns:

the all pages by type

getAllPagesMap

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

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

Returns:

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

getAllPageTemplates

Collection<PageTemplateModel> getAllPageTemplates(boolean active)

returns all page templates (only of the active catalogVersion)

Parameters:

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

Returns:

all page templates

getAllPageTemplates

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

Gets the all page templates.

Parameters:

catalogVersions - the catalog versions

Returns:

the all page templates

getAllRestrictedPageTemplates

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

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

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

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

Gets the content pages.

Parameters:

catalogVersions - the catalog versions

label - the label

Returns:

the content pages

getPageById

@Deprecated
AbstractPageModel getPageById(String id)
                                   throws CMSItemNotFoundException

Deprecated. use getPageForIdFromActiveCatalogVersion(String) instead.

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

Parameters:

id - the id of the page

Returns:

the page for id

Throws:

CMSItemNotFoundException - if no page with the given id is found

getPageForIdFromActiveCatalogVersion

AbstractPageModel getPageForIdFromActiveCatalogVersion(String id)
                                                throws AmbiguousIdentifierException,
                                                       UnknownIdentifierException

Returns the page with the given id from active catalogVersion.

Parameters:

id - the id of the page

Returns:

the page for id

Throws:

AmbiguousIdentifierException

UnknownIdentifierException

getPageTemplateById

@Deprecated
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

Parameters:

id -

Returns:

the page template for id

Throws:

CMSItemNotFoundException - if no template with the given id is found

getPageTemplateForIdFromActiveCatalogVersion

PageTemplateModel getPageTemplateForIdFromActiveCatalogVersion(String id)
                                                        throws AmbiguousIdentifierException,
                                                               UnknownIdentifierException

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

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

boolean pageExists(String id)

Checks if a page exists in the active catalog version

Parameters:

id - page id

Returns:

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

save

@Deprecated
void save(AbstractPageModel page)

Deprecated. use ModelService.save(Object) instead.

Saves page model.

Parameters:

page - the page model object

updatePage

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

Updates the given page. Method explicitly saves object.

Parameters:

page -

name -

masterTemplateId -

Throws:

CMSItemNotFoundException

getHomepage

ContentPageModel getHomepage(CMSSiteModel siteModel)

Gets the homepage for a given CMS Site.

Parameters:

siteModel -

Returns:

the homepage model

findPagesByType

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

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

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