de.hybris.platform.cms2.servicelayer.daos

Interface CMSComponentDao

All Superinterfaces:

Dao

All Known Implementing Classes:

DefaultCMSComponentDao

public interface CMSComponentDao
extends Dao

The Interface CMSComponentDao for finding CMS Components.

Spring Bean ID:

cmsComponentDao

Method Summary

Modifier and Type	Method and Description
List<AbstractCMSComponentModel>	findAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion) Find cms components that belong to a given catalog version.
SearchResult<AbstractCMSComponentModel>	findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel, String mask, PageableData pageableData) For a given mask used as filter and a PageableData query, 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
AbstractCMSComponentModel	findCMSComponent(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Deprecated. use findCMSComponents(String, String, Collection) instead.
AbstractCMSComponentModel	findCMSComponentById(String id) Deprecated. use findCMSComponentsById(String) instead.
AbstractCMSComponentModel	findCMSComponentByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Deprecated. use findCMSComponentsByIdAndCatalogVersion(String, CatalogVersionModel) instead.
AbstractCMSComponentModel	findCMSComponentByIdAndCatalogVersions(String id, Collection<CatalogVersionModel> catalogVersions) Deprecated. use findCMSComponentsByIdAndCatalogVersions(String, Collection) instead.
AbstractCMSComponentContainerModel	findCMSComponentContainerByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Deprecated. use findCMSComponentContainersByIdAndCatalogVersion(String, CatalogVersionModel) instead.
List<AbstractCMSComponentContainerModel>	findCMSComponentContainersByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms component containers by id and catalog version.
List<AbstractCMSComponentModel>	findCMSComponents(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions) Find cms components by id, contentSlotId and catalog versions.
List<AbstractCMSComponentModel>	findCMSComponentsById(String id) Find cms components by id.
List<AbstractCMSComponentModel>	findCMSComponentsByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms components by id and catalog version.
List<AbstractCMSComponentModel>	findCMSComponentsByIdAndCatalogVersions(String id, Collection<CatalogVersionModel> catalogVersions) Find cms components by id and catalog versions.
List<SimpleCMSComponentModel>	findCMSComponentsOfContainerByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms components of container by id and catalog version.

Method Detail

findCMSComponentByIdAndCatalogVersions

@Deprecated
AbstractCMSComponentModel findCMSComponentByIdAndCatalogVersions(String id,
                                                                             Collection<CatalogVersionModel> catalogVersions)

Deprecated. use findCMSComponentsByIdAndCatalogVersions(String, Collection) instead.

Find cms component by id and catalog versions.

Parameters:

id - the id of CMS component

catalogVersions - the collection of catalog versions

Returns:

the abstract cms component model or null when not found

findCMSComponentsByIdAndCatalogVersions

List<AbstractCMSComponentModel> findCMSComponentsByIdAndCatalogVersions(String id,
                                                                        Collection<CatalogVersionModel> catalogVersions)

Find cms components by id and catalog versions.

Parameters:

id - the id of CMS component

catalogVersions - the collection of catalog versions

Returns:

the list of found CMS component objects or empty list when not found.

findCMSComponent

@Deprecated
AbstractCMSComponentModel findCMSComponent(String id,
                                                       String contentSlotId,
                                                       Collection<CatalogVersionModel> catalogVersions)

Deprecated. use findCMSComponents(String, String, Collection) instead.

Find cms component.

Parameters:

id - the id

contentSlotId - the content slot id

catalogVersions - the catalog versions

Returns:

the abstract cms component model or null when not found

findCMSComponents

List<AbstractCMSComponentModel> findCMSComponents(String id,
                                                  String contentSlotId,
                                                  Collection<CatalogVersionModel> catalogVersions)

Find cms components by id, contentSlotId and catalog versions.

Parameters:

id - the id of CMS component.

contentSlotId - the if of content slot

catalogVersions - the collection of catalog versions

Returns:

the list of found CMS component objects or empty list when not found.

findCMSComponentByIdAndCatalogVersion

@Deprecated
AbstractCMSComponentModel findCMSComponentByIdAndCatalogVersion(String id,
                                                                            CatalogVersionModel catalogVersion)

Deprecated. use findCMSComponentsByIdAndCatalogVersion(String, CatalogVersionModel) instead.

Find cms component by id and catalog version.

Parameters:

id - the id

catalogVersion - the catalog version

Returns:

the abstract cms component model or null when not found

findCMSComponentsByIdAndCatalogVersion

List<AbstractCMSComponentModel> findCMSComponentsByIdAndCatalogVersion(String id,
                                                                       CatalogVersionModel catalogVersion)

Find cms components by id and catalog version.

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found CMS component objects.

findCMSComponentById

@Deprecated
AbstractCMSComponentModel findCMSComponentById(String id)

Deprecated. use findCMSComponentsById(String) instead.

Find cms component by id.

Parameters:

id - the id

Returns:

the abstract cms component model or null when not found

findCMSComponentsById

List<AbstractCMSComponentModel> findCMSComponentsById(String id)

Find cms components by id.

Parameters:

id - the id of CMS component

Returns:

the list of found CMS component objects or empty list when not found.

findCMSComponentContainerByIdAndCatalogVersion

@Deprecated
AbstractCMSComponentContainerModel findCMSComponentContainerByIdAndCatalogVersion(String id,
                                                                                              CatalogVersionModel catalogVersion)

Deprecated. use findCMSComponentContainersByIdAndCatalogVersion(String, CatalogVersionModel) instead.

Find cms component container by id and catalog version.

Parameters:

id - the id

catalogVersion - the catalog version

Returns:

the abstract cms component container model or null when not found

findCMSComponentContainersByIdAndCatalogVersion

List<AbstractCMSComponentContainerModel> findCMSComponentContainersByIdAndCatalogVersion(String id,
                                                                                         CatalogVersionModel catalogVersion)

Find cms component containers by id and catalog version.

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found CMS component container objects or empty list when not found.

findCMSComponentsOfContainerByIdAndCatalogVersion

List<SimpleCMSComponentModel> findCMSComponentsOfContainerByIdAndCatalogVersion(String id,
                                                                                CatalogVersionModel catalogVersion)

Find cms components of container by id and catalog version.

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found simple CMS component objects or empty list when not found.

findAllCMSComponentsByCatalogVersion

List<AbstractCMSComponentModel> findAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion)

Find cms components that belong to a given catalog version.

Parameters:

catalogVersion - - the catalog version

Returns:

the list of cms components belonging to the given catalog version or an empty list.

findByCatalogVersionAndMask

SearchResult<AbstractCMSComponentModel> findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel,
                                                                    String mask,
                                                                    PageableData pageableData)

For a given mask used as filter and a PageableData query, 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

Parameters:

catalogVersionModel - the catalog version to filter on

mask - the string value on which components will be filtered, implementations may choose to filter on the component name

pageableData - the PageableData object 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