de.hybris.platform.cmswebservices.pagesrestrictions.controller

Class PagesRestrictionsController

java.lang.Object

de.hybris.platform.cmswebservices.pagesrestrictions.controller.PagesRestrictionsController

public class PagesRestrictionsController
extends Object

Controller that provides an API to retrieve all pages and their restrictions.

Constructor Summary

Constructors

Constructor and Description
PagesRestrictionsController()

Method Summary

Modifier and Type	Method and Description
PageRestrictionListData	getAllPagesRestrictions() Find restrictions for all pages.
PageRestrictionListData	getAllPagesRestrictionsByPageIds(List<String> pageIds) Retrieve all restrictions that belong to the page for the given page ids.
protected PageRestrictionListData	getAllRestrictionsByPage(String pageId)
protected PageRestrictionFacade	getPageRestrictionFacade()
PageRestrictionListData	getRestrictionsByPage(String pageId) Retrieve all restrictions that belong to the page for the given page id.
void	setPageRestrictionFacade(PageRestrictionFacade pageRestrictionFacade)
PageRestrictionListData	updatePageRestrictionListData(String pageId, PageRestrictionListData pageRestrictionListData) Updates the list of page-restriction relations for the given page id.

Methods inherited from class java.lang.Object

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

Constructor Detail

PagesRestrictionsController

public PagesRestrictionsController()

Method Detail

getAllPagesRestrictions

public PageRestrictionListData getAllPagesRestrictions()

Find restrictions for all pages.

Returns:

a dto which serves as a wrapper object that contains a list of PageRestrictionListData; never null

getAllPagesRestrictionsByPageIds

public PageRestrictionListData getAllPagesRestrictionsByPageIds(List<String> pageIds)

Retrieve all restrictions that belong to the page for the given page ids.

Returns:

a dto which serves as a wrapper object that contains a list of PageRestrictionListData; never null

getRestrictionsByPage

public PageRestrictionListData getRestrictionsByPage(String pageId)

Retrieve all restrictions that belong to the page for the given page id.

Parameters:

pageId - Identifier of the page

Returns:

a dto which serves as a wrapper object that contains a list of PageRestrictionListData; never null

getAllRestrictionsByPage

protected PageRestrictionListData getAllRestrictionsByPage(String pageId)

updatePageRestrictionListData

public PageRestrictionListData updatePageRestrictionListData(String pageId,
                                                             PageRestrictionListData pageRestrictionListData)
                                                      throws CMSItemNotFoundException,
                                                             WebserviceValidationException

Updates the list of page-restriction relations for the given page id.

Parameters:

pageId - page identifier

pageRestrictionListData - list of PageRestrictionData

Returns:

a dto which serves as a wrapper object that contains the updated list of PageRestrictionListData; never null

Throws:

CMSItemNotFoundException - if it cannot find the component

WebserviceValidationException - if there is any validation error

getPageRestrictionFacade

protected PageRestrictionFacade getPageRestrictionFacade()

setPageRestrictionFacade

public void setPageRestrictionFacade(PageRestrictionFacade pageRestrictionFacade)