de.hybris.platform.cmswebservices.items.controller

Class ItemController

java.lang.Object

de.hybris.platform.cmswebservices.items.controller.ItemController

public class ItemController
extends Object

Controller to deal with component items

Constructor Summary

Constructors

Constructor and Description
ItemController()

Method Summary

Modifier and Type	Method and Description
AbstractCMSComponentData	createAndAddNewComponent(AbstractCMSComponentData componentData, HttpServletRequest request, HttpServletResponse response) Create a new component.
ComponentItemListData	getAllComponentItems(String fields) Find all components.
ComponentItemListData	getAllComponentItemsForUids(String[] uids) Find components matching the given uids.
protected ComponentItemFacade	getComponentFacade()
AbstractCMSComponentData	getComponentItemByUid(String componentId, String fields) Get the component that matches the given component id.
protected LocationHeaderResource	getLocationHeaderResource()
void	removeComponent(String componentId) Remove a component from the system.
void	setComponentFacade(ComponentItemFacade componentFacade)
void	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
void	updateComponent(String componentId, AbstractCMSComponentData componentData) Update a component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemController

public ItemController()

Method Detail

getAllComponentItems

public ComponentItemListData getAllComponentItems(String fields)

Find all components.
By default, the result is ordered by modified time; most recently modified items first.

Returns:

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

getAllComponentItemsForUids

public ComponentItemListData getAllComponentItemsForUids(String[] uids)

Find components matching the given uids.

Returns:

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

getComponentItemByUid

public AbstractCMSComponentData getComponentItemByUid(String componentId,
                                                      String fields)
                                               throws CMSItemNotFoundException,
                                                      ConversionException

Get the component that matches the given component id.

Returns:

AbstractCMSComponentData

Throws:

CMSItemNotFoundException - when the item has not been found

ConversionException

createAndAddNewComponent

public AbstractCMSComponentData createAndAddNewComponent(AbstractCMSComponentData componentData,
                                                         HttpServletRequest request,
                                                         HttpServletResponse response)

Create a new component.
When the slotId and the positionId are specified in the request, the newly created component will be assigned to a content slot at the stated position.

Parameters:

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

AbstractCMSComponentData

updateComponent

public void updateComponent(String componentId,
                            AbstractCMSComponentData componentData)
                     throws WebserviceValidationException,
                            CMSItemNotFoundException

Update a component.

Throws:

WebserviceValidationException - if there is any validation error

CMSItemNotFoundException - if it cannot find the component

removeComponent

public void removeComponent(String componentId)
                     throws CMSItemNotFoundException

Remove a component from the system.

Throws:

CMSItemNotFoundException - if it cannot find the component

getComponentFacade

protected ComponentItemFacade getComponentFacade()

setComponentFacade

public void setComponentFacade(ComponentItemFacade componentFacade)

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)