Interface CMSComponentService

All Known Implementing Classes:
DefaultCMSComponentService

public interface CMSComponentService
The Interface CMSComponentService provides methods for managing cms components.
Spring Bean ID:
cmsComponentService
  • Method Details

    • getAbstractCMSComponent

      <T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id) throws CMSItemNotFoundException
      Gets the abstract cms component.
      Type Parameters:
      T - the generic type
      Parameters:
      id - the id of cms component to get
      Returns:
      the abstract cms component
      Throws:
      CMSItemNotFoundException - thrown when item was not found
    • getAbstractCMSComponents

      <T extends AbstractCMSComponentModel> SearchPageData<T> getAbstractCMSComponents(Collection<String> ids, SearchPageData searchPageData)
      Gets the abstract cms component.
      Type Parameters:
      T - the AbstractCMSComponentModel subclass type
      Parameters:
      ids - the id collection of cms components to get
      searchPageData - the searchPageData contains requested pagination and sorting information
      Returns:
      the list of abstract cms component in SearchPageData; otherwise return an empty collection result when no component is found
    • getAllAbstractCMSComponents

      <T extends AbstractCMSComponentModel> SearchPageData<T> getAllAbstractCMSComponents(SearchPageData searchPageData)
      Gets all abstract cms components filtered by the specified pagination and sorting information.
      Type Parameters:
      T - the AbstractCMSComponentModel subclass type
      Parameters:
      searchPageData - the searchPageData contains requested pagination and sorting information
      Returns:
      the list of abstract cms component in SearchPageData; otherwise return an empty collection result when no component is found
    • getAbstractCMSComponent

      <T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id, Collection<CatalogVersionModel> catalogVersions) throws CMSItemNotFoundException
      Gets the abstract cms component.
      Type Parameters:
      T - the generic type
      Parameters:
      id - the id of cms component to get
      catalogVersions - the catalog versions
      Returns:
      the abstract cms component
      Throws:
      CMSItemNotFoundException - thrown when item was not found
    • getAbstractCMSComponent

      <T extends AbstractCMSComponentModel> T getAbstractCMSComponent(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) throws CMSItemNotFoundException
      Gets the abstract cms component.
      Type Parameters:
      T - the generic type
      Parameters:
      id - the id of cms component to get
      contentSlotId - the content slot id
      catalogVersions - the catalog versions
      Returns:
      the abstract cms component
      Throws:
      CMSItemNotFoundException - thrown when item was not found
    • getEditorProperties

      Collection<String> getEditorProperties(AbstractCMSComponentModel component)
      Get all editor properties for the given content element. Editor-Properties are editorial properties, like headline, image and so on. Editor-Properties are used to display information on the frontend.
      Parameters:
      component - the component which editor properties should be retrieved
      Returns:
      all editor properties
    • getReadableEditorProperties

      Collection<String> getReadableEditorProperties(AbstractCMSComponentModel component)
      Get all readable editor properties for the given content element. See getEditorProperties(AbstractCMSComponentModel) for retrieving all editor properties.
      Parameters:
      component - the component which editor properties should be retrieved
      Returns:
      readable editor properties
    • getSimpleCMSComponent

      <T extends SimpleCMSComponentModel> T getSimpleCMSComponent(String id) throws CMSItemNotFoundException
      Gets the simple cms component.
      Type Parameters:
      T - the generic type
      Parameters:
      id - the id of component to get
      Returns:
      the simple cms component
      Throws:
      CMSItemNotFoundException - thrown when item was not found
    • getSystemProperties

      Collection<String> getSystemProperties(AbstractCMSComponentModel component)
      Get all system properties for the given content element. System-Properties are non editorial properties, like id, catalogVersion and so on. System-Properties are not used to display any information on the frontend.
      Parameters:
      component - the component which system properties should be retrieved
      Returns:
      collection of all system properties for component
    • isComponentRestricted

      boolean isComponentRestricted(AbstractCMSComponentModel component)
      Checks if passed as parameter AbstractCMSComponentModel is restricted restricted.
      Parameters:
      component - the component which is checked against any restrictions
      Returns:
      true if is restricted, false otherwise
    • isComponentContainer

      boolean isComponentContainer(String componentTypeCode)
      Checks if component is a container.
      Parameters:
      componentTypeCode - the component's ComposedType code
      Returns:
      Boolean.TRUE if is component, Boolean.FALSE otherwise
    • isComponentUsedOutsidePage

      boolean isComponentUsedOutsidePage(AbstractCMSComponentModel component, AbstractPageModel page)
      Checks if the component is used outside the page provided as reference.
      Parameters:
      component - The component to check.
      page - The page used as reference.
      Returns:
      Boolean.TRUE if the component is used elsewhere. Boolean.FALSE if it's never used or if it's only used in the reference page.
    • getAllParents

      default Set<AbstractCMSComponentModel> getAllParents(AbstractCMSComponentModel component)
      Get a CMSComponent's parent components and parents' parents.
      Parameters:
      component - The CMS component.
      Returns:
      List of all parents of a component.
    • getAllChildren

      default Set<AbstractCMSComponentModel> getAllChildren(AbstractCMSComponentModel component)
      Get a CMSComponent's all children and children's children.
      Parameters:
      component - The CMS component.
      Returns:
      List of all parents of a component.
    • inSharedSlots

      default boolean inSharedSlots(AbstractCMSComponentModel component)
      Check if a component is in shared slot or not.
      Parameters:
      component - The CMS component.
      Returns:
      boolean