Class DefaultCMSComponentDao
java.lang.Object
de.hybris.platform.servicelayer.internal.dao.AbstractItemDao
de.hybris.platform.cms2.servicelayer.daos.impl.AbstractCMSItemDao
de.hybris.platform.cms2.servicelayer.daos.impl.DefaultCMSComponentDao
- All Implemented Interfaces:
CMSComponentDao,Dao
- Direct Known Subclasses:
DefaultMarketplaceCMSComponentDao
Default implementation of
CMSComponentDao interface.-
Field Summary
FieldsFields inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao
flexibleSearchService, modelService -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfindAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion) Find cms components that belong to a given catalog version.<T extends AbstractCMSComponentModel>
SearchPageData<T>findAllCMSComponentsByCatalogVersions(Collection<CatalogVersionModel> catalogVersions, SearchPageData searchPageData) Find cms components that belong to a given catalog version.findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel, String mask, PageableData pageableData) For a given mask used as filter and aPageableDataquery, will return a page object consisting of the content list of the requested page number and the total number of entities for the given maskfindCMSComponentContainersByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms component containers by id and catalog version.findCMSComponents(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Find cms components by id, contentSlotId and catalog versions.Find cms components by id.findCMSComponentsByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms components by id and catalog version.findCMSComponentsByIdAndCatalogVersions(String id, Collection<CatalogVersionModel> catalogVersions) Find cms components by id and catalog versions.<T extends AbstractCMSComponentModel>
SearchPageData<T>findCMSComponentsByIdsAndCatalogVersions(Collection<String> ids, Collection<CatalogVersionModel> catalogVersions, SearchPageData searchPageDataInput) Find cms components by list of IDs and catalog versions with pagination and sorting.findCMSComponentsOfContainerByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms components of container by id and catalog version.longgetComponentReferenceCountOutsidePage(AbstractCMSComponentModel componentModel, AbstractPageModel pageModel) Finds the number of times the given component is used outside a given page (e.g., other pages or shared slots).protected PaginatedFlexibleSearchServicevoidsetPaginatedFlexibleSearchService(PaginatedFlexibleSearchService paginatedFlexibleSearchService) Methods inherited from class de.hybris.platform.cms2.servicelayer.daos.impl.AbstractCMSItemDao
buildQuery, findSortQuery, getCmsSortQueryDataRegistry, setCmsSortQueryDataRegistryMethods inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao
getAllSources, getFlexibleSearchService, getModelService, getSource, load, loadAll, search, search, searchUnique, setFlexibleSearchService, setModelService
-
Field Details
-
CATALOG_VERSIONS_QUERY_PARAM
- See Also:
-
QUERY_ALIAS
- See Also:
-
-
Constructor Details
-
DefaultCMSComponentDao
public DefaultCMSComponentDao()
-
-
Method Details
-
findByCatalogVersionAndMask
public SearchResult<AbstractCMSComponentModel> findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel, String mask, PageableData pageableData) Description copied from interface:CMSComponentDaoFor a given mask used as filter and aPageableDataquery, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask- Specified by:
findByCatalogVersionAndMaskin interfaceCMSComponentDao- Parameters:
catalogVersionModel- the catalog version to filter onmask- the string value on which components will be filtered, implementations may choose to filter on the component namepageableData- thePageableDataobject containing the page request details. PageableData may contain a String value for sort, this will be used by a sorting strategy to select the most appropriate query or resort to a default one.- Returns:
- a page object
-
findCMSComponentsOfContainerByIdAndCatalogVersion
public List<SimpleCMSComponentModel> findCMSComponentsOfContainerByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms components of container by id and catalog version.- Specified by:
findCMSComponentsOfContainerByIdAndCatalogVersionin interfaceCMSComponentDao- Parameters:
id- the id of CMS componentcatalogVersion- the catalog version- Returns:
- the list of found simple CMS component objects or empty list when not found.
-
findCMSComponentsByIdAndCatalogVersions
public List<AbstractCMSComponentModel> findCMSComponentsByIdAndCatalogVersions(String id, Collection<CatalogVersionModel> catalogVersions) Find cms components by id and catalog versions.- Specified by:
findCMSComponentsByIdAndCatalogVersionsin interfaceCMSComponentDao- Parameters:
id- the id of CMS componentcatalogVersions- the collection of catalog versions- Returns:
- the list of found CMS component objects or empty list when not found.
-
findCMSComponentsByIdsAndCatalogVersions
public <T extends AbstractCMSComponentModel> SearchPageData<T> findCMSComponentsByIdsAndCatalogVersions(Collection<String> ids, Collection<CatalogVersionModel> catalogVersions, SearchPageData searchPageDataInput) Find cms components by list of IDs and catalog versions with pagination and sorting.- Specified by:
findCMSComponentsByIdsAndCatalogVersionsin interfaceCMSComponentDao- Type Parameters:
T- the AbstractCMSComponentModel subclass type- Parameters:
ids- the collection of ids of CMS componentscatalogVersions- the collection of catalog versionssearchPageDataInput- the searchPageData contains requested pagination and sorting information- Returns:
- the list of found CMS component objects in SearchPageData
-
findCMSComponents
public List<AbstractCMSComponentModel> findCMSComponents(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Find cms components by id, contentSlotId and catalog versions.- Specified by:
findCMSComponentsin interfaceCMSComponentDao- Parameters:
id- the id of CMS component.contentSlotId- the if of content slotcatalogVersions- the collection of catalog versions- Returns:
- the list of found CMS component objects or empty list when not found.
-
findCMSComponentsByIdAndCatalogVersion
public List<AbstractCMSComponentModel> findCMSComponentsByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms components by id and catalog version.- Specified by:
findCMSComponentsByIdAndCatalogVersionin interfaceCMSComponentDao- Parameters:
id- the id of CMS componentcatalogVersion- the catalog version- Returns:
- the list of found CMS component objects.
-
findCMSComponentsById
Find cms components by id.- Specified by:
findCMSComponentsByIdin interfaceCMSComponentDao- Parameters:
id- the id of CMS component- Returns:
- the list of found CMS component objects or empty list when not found.
-
findCMSComponentContainersByIdAndCatalogVersion
public List<AbstractCMSComponentContainerModel> findCMSComponentContainersByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms component containers by id and catalog version.- Specified by:
findCMSComponentContainersByIdAndCatalogVersionin interfaceCMSComponentDao- Parameters:
id- the id of CMS componentcatalogVersion- the catalog version- Returns:
- the list of found CMS component container objects or empty list when not found.
-
findAllCMSComponentsByCatalogVersion
public List<AbstractCMSComponentModel> findAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion) Description copied from interface:CMSComponentDaoFind cms components that belong to a given catalog version.- Specified by:
findAllCMSComponentsByCatalogVersionin interfaceCMSComponentDao- Parameters:
catalogVersion- - the catalog version- Returns:
- the list of cms components belonging to the given catalog version or an empty list.
-
findAllCMSComponentsByCatalogVersions
public <T extends AbstractCMSComponentModel> SearchPageData<T> findAllCMSComponentsByCatalogVersions(Collection<CatalogVersionModel> catalogVersions, SearchPageData searchPageData) Description copied from interface:CMSComponentDaoFind cms components that belong to a given catalog version.- Specified by:
findAllCMSComponentsByCatalogVersionsin interfaceCMSComponentDao- Parameters:
catalogVersions- - the collection of catalog versionssearchPageData- - the searchPageData contains requested pagination and sorting information- Returns:
- the list of cms components belonging to the given catalog version and searchPageData; or an empty list.
-
getComponentReferenceCountOutsidePage
public long getComponentReferenceCountOutsidePage(AbstractCMSComponentModel componentModel, AbstractPageModel pageModel) Description copied from interface:CMSComponentDaoFinds the number of times the given component is used outside a given page (e.g., other pages or shared slots).- Specified by:
getComponentReferenceCountOutsidePagein interfaceCMSComponentDao- Parameters:
componentModel- - The component whose references to count.pageModel- - The page not to be included in the component references count.- Returns:
- The number of times the given component is used outside the given page.
-
getPaginatedFlexibleSearchService
-
setPaginatedFlexibleSearchService
public void setPaginatedFlexibleSearchService(PaginatedFlexibleSearchService paginatedFlexibleSearchService)
-