Package de.hybris.platform.cms2.servicelayer.services

Interface CMSContentSlotService

All Known Implementing Classes:
DefaultCMSContentSlotService
public interface CMSContentSlotService
The Interface CMSContentSlotService provides methods for managing content slots.
Spring Bean ID:
cmsContentSlotService

  • Method Details

    • getContentSlotForId

      ContentSlotModel getContentSlotForId(String id) throws AmbiguousIdentifierException, UnknownIdentifierException
      Gets the content slot for given id.
      Parameters:
      id - the id of content slot to find
      Returns:
      found content slot
      Throws:
      AmbiguousIdentifierException - thrown when more than one object has been found.
      UnknownIdentifierException - thrown when no object has been found

    • getSimpleCMSComponents

      List<SimpleCMSComponentModel> getSimpleCMSComponents(ContentSlotModel contentSlot, boolean previewEnabled, javax.servlet.http.HttpServletRequest httRequest)
      Retrieves a list of components that are valid for particular content slot

      Note: Filters components that are assigned to given content slot according to their restrictions. For more information please see

      Parameters:
      contentSlot - given content slot
      previewEnabled - flag that indicates whether preview is enabled
      httRequest - current HTTP request
      Returns:
      valid components
      See Also:

    • getAvailableContentSlotsNames

      String getAvailableContentSlotsNames(AbstractPageModel page)
      Gets the available content slots names and return them as semicolon separated string ("foo; bar; baz").
      Parameters:
      page - the AbstractPageModel object. *
      Returns:
      the available content slots names as semicolon separated string.

    • getMissingContentSlotsNames

      String getMissingContentSlotsNames(AbstractPageModel page)
      Gets the missing content slots names and return them as semicolon separated string ("foo; bar; baz").
      Parameters:
      page - the AbstractPageModel object.
      Returns:
      the missing content slots names.

    • getDefinedContentSlotPositions

      List<String> getDefinedContentSlotPositions(PageTemplateModel pageTemplate)
      Gets the defined content slot positions.
      Parameters:
      pageTemplate - the page template
      Returns:
      the defined content slot positions

    • getDefinedContentSlotPositions

      List<String> getDefinedContentSlotPositions(AbstractPageModel page)
      Gets the defined content slot positions.
      Parameters:
      page - the page
      Returns:
      the defined content slot positions

    • getPagesForContentSlot

      Collection<AbstractPageModel> getPagesForContentSlot(ContentSlotModel contentSlot)
      Gets the related AbstractPageModel objects for content slot.
      Parameters:
      contentSlot - the ContentSlotModel object for which pages will be obtained.
      Returns:
      the collection of AbstractPageModel objects related to ContentSlotModel object.

    • isSharedSlot

      default boolean isSharedSlot(ContentSlotModel contentSlot)
      Check a content slot is shared or not. A slot is related to a page template or a slot is related multi-pages
      Parameters:
      contentSlot - the ContentSlotModel
      Returns:
      boolean