de.hybris.platform.cmswebservices.pages.controller

Class PageController

java.lang.Object

de.hybris.platform.cmswebservices.pages.controller.PageController

public class PageController
extends Object

Controller to deal with AbstractPageModel objects

Constructor Summary

Constructors

Constructor and Description
PageController()

Method Summary

Modifier and Type	Method and Description
protected UidListData	convertToUidListData(List<String> pageIds)
AbstractPageData	createPage(AbstractPageData pageData, HttpServletRequest request, HttpServletResponse response) Create a new page.
PageListData	findAllPages() Find all pages.
UidListData	findFallbackPages(String pageId) Get all fallback pages uid for a given page.
PageListData	findPagesByIds(List<String> uids) Find specific pages.
PageListData	findPagesByType(String typeCode, Boolean isDefaultPage) Get all default or variation pages that matches the given page type.
UidListData	findVariationPages(String pageId) Get all variation pages uid for a given page.
protected PageFacade	getCmsPageFacade()
protected LocationHeaderResource	getLocationHeaderResource()
AbstractPageData	getPageByUid(String pageId) Get the page that matches the given page uid.
void	setCmsPageFacade(PageFacade pageFacade)
void	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
AbstractPageData	updatePage(String pageId, AbstractPageData pageData) Update a page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageController

public PageController()

Method Detail

findAllPages

public PageListData findAllPages()

Find all pages.

Returns:

all pages

findPagesByIds

public PageListData findPagesByIds(List<String> uids)

Find specific pages.

Parameters:

uids - a list of identifier of the pages that we are looking for

Returns:

(PageListData

getPageByUid

public AbstractPageData getPageByUid(String pageId)
                              throws CMSItemNotFoundException

Get the page that matches the given page uid.

Returns:

AbstractPageData

Throws:

CMSItemNotFoundException - when the page cannot be found

findPagesByType

public PageListData findPagesByType(String typeCode,
                                    Boolean isDefaultPage)

Get all default or variation pages that matches the given page type.

Returns:

all default or variation pages for a given page type

findVariationPages

public UidListData findVariationPages(String pageId)
                               throws CMSItemNotFoundException

Get all variation pages uid for a given page.

Returns:

all variation pages uid for a given page; empty if the given page is already a variation page; never null

Throws:

CMSItemNotFoundException - when the pageId is invalid

findFallbackPages

public UidListData findFallbackPages(String pageId)
                              throws CMSItemNotFoundException

Get all fallback pages uid for a given page.

Returns:

all fallback pages uid for a given page; empty if the given page is already a fallback page; never null

Throws:

CMSItemNotFoundException - when the pageId is invalid

convertToUidListData

protected UidListData convertToUidListData(List<String> pageIds)

createPage

public AbstractPageData createPage(AbstractPageData pageData,
                                   HttpServletRequest request,
                                   HttpServletResponse response)

Create a new page.

Parameters:

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

AbstractPageData

updatePage

public AbstractPageData updatePage(String pageId,
                                   AbstractPageData pageData)

Update a page.

Returns:

AbstractPageData

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)

getCmsPageFacade

protected PageFacade getCmsPageFacade()

setCmsPageFacade

public void setCmsPageFacade(PageFacade pageFacade)