de.hybris.platform.cms2.servicelayer.daos.impl

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

public class DefaultCMSComponentDao
extends AbstractCMSItemDao
implements CMSComponentDao

Default implementation of CMSComponentDao interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CATALOG_VERSIONS_QUERY_PARAM

Fields inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

flexibleSearchService, modelService

Constructor Summary

Constructors

Constructor and Description
DefaultCMSComponentDao()

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) Find cms component.
AbstractCMSComponentModel	findCMSComponentById(String id) Find cms component by id.
AbstractCMSComponentModel	findCMSComponentByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms component by id and catalog version.
AbstractCMSComponentModel	findCMSComponentByIdAndCatalogVersions(String id, Collection<CatalogVersionModel> catalogVersions) Find cms component by id and catalog versions.
AbstractCMSComponentContainerModel	findCMSComponentContainerByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion) Find cms component container by id and catalog version.
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.

Methods inherited from class de.hybris.platform.cms2.servicelayer.daos.impl.AbstractCMSItemDao

buildQuery, findSortQuery, getCmsSortQueryDataRegistry, setCmsSortQueryDataRegistry

Methods inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

getAllSources, getFlexibleSearchService, getModelService, getSource, load, loadAll, search, search, searchUnique, setFlexibleSearchService, setModelService

Methods inherited from class java.lang.Object

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

Field Detail

CATALOG_VERSIONS_QUERY_PARAM

protected static final String CATALOG_VERSIONS_QUERY_PARAM

See Also:

Constant Field Values

Constructor Detail

DefaultCMSComponentDao

public DefaultCMSComponentDao()

Method Detail

findByCatalogVersionAndMask

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

Description copied from interface: CMSComponentDao

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

Specified by:

findByCatalogVersionAndMask in interface CMSComponentDao

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

findCMSComponentContainerByIdAndCatalogVersion

public AbstractCMSComponentContainerModel findCMSComponentContainerByIdAndCatalogVersion(String id,
                                                                                         CatalogVersionModel catalogVersion)

Find cms component container by id and catalog version.

Specified by:

findCMSComponentContainerByIdAndCatalogVersion in interface CMSComponentDao

Parameters:

id - the id

catalogVersion - the catalog version

Returns:

the abstract cms component container model or null when not found

findCMSComponentById

public AbstractCMSComponentModel findCMSComponentById(String id)

Find cms component by id.

Specified by:

findCMSComponentById in interface CMSComponentDao

Parameters:

id - the id

Returns:

the abstract cms component model or null when not found

findCMSComponentByIdAndCatalogVersions

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

Find cms component by id and catalog versions.

Specified by:

findCMSComponentByIdAndCatalogVersions in interface CMSComponentDao

Parameters:

id - the id of CMS component

catalogVersions - the collection of catalog versions

Returns:

the abstract cms component model or null when not found

findCMSComponentByIdAndCatalogVersion

public AbstractCMSComponentModel findCMSComponentByIdAndCatalogVersion(String id,
                                                                       CatalogVersionModel catalogVersion)

Find cms component by id and catalog version.

Specified by:

findCMSComponentByIdAndCatalogVersion in interface CMSComponentDao

Parameters:

id - the id

catalogVersion - the catalog version

Returns:

the abstract cms component model or null when not found

findCMSComponentsOfContainerByIdAndCatalogVersion

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

Find cms components of container by id and catalog version.

Specified by:

findCMSComponentsOfContainerByIdAndCatalogVersion in interface CMSComponentDao

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.

findCMSComponent

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

Find cms component.

Specified by:

findCMSComponent in interface CMSComponentDao

Parameters:

id - the id

contentSlotId - the content slot id

catalogVersions - the catalog versions

Returns:

the abstract cms component model or null when not found

findCMSComponentsByIdAndCatalogVersions

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

Find cms components by id and catalog versions.

Specified by:

findCMSComponentsByIdAndCatalogVersions in interface CMSComponentDao

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.

findCMSComponents

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

Find cms components by id, contentSlotId and catalog versions.

Specified by:

findCMSComponents in interface CMSComponentDao

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.

findCMSComponentsByIdAndCatalogVersion

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

Find cms components by id and catalog version.

Specified by:

findCMSComponentsByIdAndCatalogVersion in interface CMSComponentDao

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found CMS component objects.

findCMSComponentsById

public List<AbstractCMSComponentModel> findCMSComponentsById(String id)

Find cms components by id.

Specified by:

findCMSComponentsById in interface CMSComponentDao

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:

findCMSComponentContainersByIdAndCatalogVersion in interface CMSComponentDao

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.

findAllCMSComponentsByCatalogVersion

public List<AbstractCMSComponentModel> findAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion)

Description copied from interface: CMSComponentDao

Find cms components that belong to a given catalog version.

Specified by:

findAllCMSComponentsByCatalogVersion in interface CMSComponentDao

Parameters:

catalogVersion - - the catalog version

Returns:

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