de.hybris.platform.cmswebservices.pagescontentslotscomponents.controller

Class PageContentSlotComponentController

java.lang.Object

de.hybris.platform.cmswebservices.pagescontentslotscomponents.controller.PageContentSlotComponentController

public class PageContentSlotComponentController
extends Object

Controller that provides an API to update components either between slots, or within a single slot.

Constructor Summary

Constructors

Constructor and Description
PageContentSlotComponentController()

Method Summary

Modifier and Type	Method and Description
PageContentSlotComponentData	addComponentToSlot(PageContentSlotComponentData pageContentSlotComponentData, HttpServletRequest request, HttpServletResponse response) Add a component to a slot.
PageContentSlotComponentListData	getComponentsByPage(String pageId) Fetches all components on a given page.
protected LocationHeaderResource	getLocationHeaderResource()
protected PageContentSlotComponentFacade	getPageContentSlotComponentFacade()
PageContentSlotComponentData	moveComponent(String pageId, String slotId, String componentId, PageContentSlotComponentData pageContentSlotComponent) Move a component to a different content slot or by changing its position within the content slot on a given page.
void	removeComponent(String slotId, String componentId) Remove a component from a content slot
void	removeComponentFromSlot(String slotId, String componentId) Deprecated. since version 6.2, please use #removeComponent(slotId, componentId)
void	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
void	setPageContentSlotComponentFacade(PageContentSlotComponentFacade contentSlotFacade)
PageContentSlotComponentData	updatePageContentSlotComponent(String pageId, String slotId, String componentId, PageContentSlotComponentData pageContentSlotComponent) Deprecated. since version 6.2, please use #moveComponent(pageId, slotId, componentId, pageContentSlotComponent)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageContentSlotComponentController

public PageContentSlotComponentController()

Method Detail

getComponentsByPage

public PageContentSlotComponentListData getComponentsByPage(String pageId)

Fetches all components on a given page.

updatePageContentSlotComponent

@Deprecated
public PageContentSlotComponentData updatePageContentSlotComponent(String pageId,
                                                                               String slotId,
                                                                               String componentId,
                                                                               PageContentSlotComponentData pageContentSlotComponent)
                                                                        throws CMSItemNotFoundException,
                                                                               ComponentNotAllowedInSlotException,
                                                                               WebserviceValidationException

Deprecated. since version 6.2, please use #moveComponent(pageId, slotId, componentId, pageContentSlotComponent)

This resource is deprecated since version 6.2, please use PUT /pagescontentslotscomponents/pages/{pageId}/contentslots/{slotId}/components/{componentId} instead.

Update a component by changing the content slot where it is placed inside a page.

Throws:

CMSItemNotFoundException

ComponentNotAllowedInSlotException

WebserviceValidationException - if there validation errors.

moveComponent

public PageContentSlotComponentData moveComponent(String pageId,
                                                  String slotId,
                                                  String componentId,
                                                  PageContentSlotComponentData pageContentSlotComponent)
                                           throws CMSItemNotFoundException,
                                                  ComponentNotAllowedInSlotException,
                                                  WebserviceValidationException

Move a component to a different content slot or by changing its position within the content slot on a given page.

Throws:

CMSItemNotFoundException

ComponentNotAllowedInSlotException

WebserviceValidationException - if there validation errors.

addComponentToSlot

public PageContentSlotComponentData addComponentToSlot(PageContentSlotComponentData pageContentSlotComponentData,
                                                       HttpServletRequest request,
                                                       HttpServletResponse response)
                                                throws CMSItemNotFoundException

Add a component to a slot.

Returns:

the PageContentSlotComponentData

Throws:

CMSItemNotFoundException - when component item does not exist

WebserviceValidationException - when validation errors are found

removeComponentFromSlot

@Deprecated
public void removeComponentFromSlot(String slotId,
                                                String componentId)
                                         throws CMSItemNotFoundException,
                                                ComponentNotFoundInSlotException

Deprecated. since version 6.2, please use #removeComponent(slotId, componentId)

This resource is deprecated since version 6.2, please use DELETE /pagescontentslotscomponents/contentslots/{slotId}/components/{componentId} instead.

Remove a component from a slot

Throws:

CMSItemNotFoundException - when the component or slot cannot be found

ComponentNotFoundInSlotException - when the component slot does not contain the component

removeComponent

public void removeComponent(String slotId,
                            String componentId)
                     throws CMSItemNotFoundException,
                            ComponentNotFoundInSlotException

Remove a component from a content slot

Throws:

CMSItemNotFoundException - when the component or slot cannot be found

ComponentNotFoundInSlotException - when the component slot does not contain the component

getPageContentSlotComponentFacade

protected PageContentSlotComponentFacade getPageContentSlotComponentFacade()

setPageContentSlotComponentFacade

public void setPageContentSlotComponentFacade(PageContentSlotComponentFacade contentSlotFacade)

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)