Package de.hybris.platform.marketplaceservices.vendor.impl

Class DefaultVendorCMSService

java.lang.Object

de.hybris.platform.marketplaceservices.vendor.impl.DefaultVendorCMSService

All Implemented Interfaces:

VendorCMSService

public class DefaultVendorCMSService
extends java.lang.Object
implements VendorCMSService

Provide CMS related services

Constructor Summary

Constructors

Constructor	Description
DefaultVendorCMSService()

Method Summary

Modifier and Type	Method	Description
protected CatalogSynchronizationService	getCatalogSynchronizationService()
protected CatalogTypeService	getCatalogTypeService()
protected CatalogVersionService	getCatalogVersionService()
java.util.Optional<AbstractCMSComponentModel>	getCMSComponentByIdAndCatalogVersion(java.lang.String id, CatalogVersionModel catalogVersion)	get component by its uid and catalog version
protected MarketplaceCMSComponentDao	getCmsComponentDao()
java.util.List<AbstractCMSComponentModel>	getCMSComponentsByContentSlotAndCatalogVersions(java.lang.String contentSlotId, java.util.List<CatalogVersionModel> catalogVersions)	get component by content slot and catalog version
protected CMSContentSlotDao	getCmsContentSlotDao()
protected CMSPageDao	getCmsPageDao()
protected CMSPageTemplateDao	getCmsPageTemplateDao()
protected CMSRestrictionDao	getCmsRestrictionDao()
java.util.Optional<ContentSlotModel>	getContentSlotByIdAndCatalogVersion(java.lang.String id, CatalogVersionModel catalogVersion)	get content slot by its uid and catalog version
java.util.Optional<ContentSlotModel>	getContentSlotByPageAndPosition(java.lang.String position, AbstractPageModel page, CatalogVersionModel catalogVersion)	get content slot by its position, page and catalog version
java.util.Optional<ContentSlotForPageModel>	getContentSlotRelationByIdAndPositionInPage(java.lang.String id, AbstractPageModel page, java.lang.String position)	get ContentSlotForPage according to its position in a page
protected java.util.List<ItemModel>	getItemList(ItemModel item)
protected ModelService	getModelService()
java.util.Optional<AbstractPageModel>	getPageByIdAndCatalogVersion(java.lang.String id, CatalogVersionModel catalogVersion)	get page by it and catalog version
java.util.Optional<PageTemplateModel>	getPageTemplateByIdAndCatalogVersion(java.lang.String id, CatalogVersionModel catalogVersion)	get page template by given id in given catalog version
protected SynchronizationStatusService	getPlatformSynchronizationStatusService()
SyncItemStatus	getProductCarouselSynchronizationStatus(ProductCarouselComponentModel carousel)	Gets the synchronization item status for a given ProductCarouselComponentModel
protected SyncItemJobModel	getRelevantSyncItemJob(SyncRequestData syncRequestData, ItemModel item)
java.util.Optional<AbstractRestrictionModel>	getRestrictionByIdAndCatalogVersion(java.lang.String id, CatalogVersionModel catalogVersion)	get restriction by id and catalog version
protected SearchRestrictionService	getSearchRestrictionService()
protected SessionService	getSessionService()
protected SyncConfig	getSyncConfig()
protected SyncRequestData	getSyncRequestData(ProductCarouselComponentModel model)
protected boolean	isExecutableInLocalView(SyncRequestData syncRequestData, ItemModel item)
protected boolean	isOutboundSynchronization(SyncRequestData syncRequestData, ItemModel item)
void	performProductCarouselSynchronization(ProductCarouselComponentModel carousel, boolean synchronous)	Performs the synchronization of a model of ProductCarouselComponentModel taking in consideration the source and target catalog versions.
ContentSlotModel	saveOrUpdateCMSContentSlot(CatalogVersionModel catalogVersion, java.lang.String uid, java.lang.String name, boolean active)	create content slot
void	saveOrUpdateCMSContentSlotForPage(CatalogVersionModel catalogVersion, java.lang.String uid, java.lang.String position, AbstractPageModel page, ContentSlotModel contentSlot)	create the content slot for a CMS page
VendorPageModel	saveOrUpdateCMSVendorPage(java.lang.String pageUid, java.lang.String pageName, CatalogVersionModel catalogVersion, PageTemplateModel pageTemplate, boolean isDefaultPage, CmsApprovalStatus approvalStatus)	create an instance of CMS VendorPageModel
void	saveOrUpdateCMSVendorRestriction(VendorModel vendor, CatalogVersionModel catalogVersion, java.lang.String uid, java.lang.String name, AbstractPageModel... pages)	create an instance of page restriction for a vendor
JspIncludeComponentModel	saveOrUpdateJspIncludeComponent(CatalogVersionModel catalogVersion, java.lang.String uid, java.lang.String name, java.lang.String page)	create JSP include component
ProductCarouselComponentModel	saveOrUpdateProductCarouselComponent(CatalogVersionModel catalogVersion, java.lang.String uid, java.lang.String name, CarouselScroll scroll, boolean popup)	create product carousel component
void	setCatalogSynchronizationService(CatalogSynchronizationService catalogSynchronizationService)
void	setCatalogTypeService(CatalogTypeService catalogTypeService)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setCmsComponentDao(MarketplaceCMSComponentDao cmsComponentDao)
void	setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)
void	setCmsPageDao(CMSPageDao cmsPageDao)
void	setCmsPageTemplateDao(CMSPageTemplateDao cmsPageTemplateDao)
void	setCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao)
void	setModelService(ModelService modelService)
void	setPlatformSynchronizationStatusService(SynchronizationStatusService platformSynchronizationStatusService)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionService(SessionService sessionService)
void	setSyncConfig(SyncConfig syncConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVendorCMSService

public DefaultVendorCMSService()

Method Detail

getPageTemplateByIdAndCatalogVersion

public java.util.Optional<PageTemplateModel> getPageTemplateByIdAndCatalogVersion(java.lang.String id,
                                                                                  CatalogVersionModel catalogVersion)

Description copied from interface: VendorCMSService

get page template by given id in given catalog version

Specified by:

getPageTemplateByIdAndCatalogVersion in interface VendorCMSService

Parameters:

id - the given template id

catalogVersion - the given catalog version

Returns:

Optional of the instance of the page template if found and empty optional otherwise

getPageByIdAndCatalogVersion

public java.util.Optional<AbstractPageModel> getPageByIdAndCatalogVersion(java.lang.String id,
                                                                          CatalogVersionModel catalogVersion)

Description copied from interface: VendorCMSService

get page by it and catalog version

Specified by:

getPageByIdAndCatalogVersion in interface VendorCMSService

Parameters:

id - the uid of the page

catalogVersion - the catalog version

Returns:

Optional of the instance of the page if found and empty optional otherwise

getRestrictionByIdAndCatalogVersion

public java.util.Optional<AbstractRestrictionModel> getRestrictionByIdAndCatalogVersion(java.lang.String id,
                                                                                        CatalogVersionModel catalogVersion)

Description copied from interface: VendorCMSService

get restriction by id and catalog version

Specified by:

getRestrictionByIdAndCatalogVersion in interface VendorCMSService

Parameters:

id - the uid of the restriction

catalogVersion - the catalog version

Returns:

Optional of the instance of the restriction if found and empty optional otherwise

getContentSlotRelationByIdAndPositionInPage

public java.util.Optional<ContentSlotForPageModel> getContentSlotRelationByIdAndPositionInPage(java.lang.String id,
                                                                                               AbstractPageModel page,
                                                                                               java.lang.String position)

Description copied from interface: VendorCMSService

get ContentSlotForPage according to its position in a page

Specified by:

getContentSlotRelationByIdAndPositionInPage in interface VendorCMSService

Parameters:

id - ContentSlotForPage's Id

page - the instance of page

position - the specific position

Returns:

tOptional of the instance of the content slot relation if found and empty optional otherwise

getContentSlotByIdAndCatalogVersion

public java.util.Optional<ContentSlotModel> getContentSlotByIdAndCatalogVersion(java.lang.String id,
                                                                                CatalogVersionModel catalogVersion)

Description copied from interface: VendorCMSService

get content slot by its uid and catalog version

Specified by:

getContentSlotByIdAndCatalogVersion in interface VendorCMSService

Parameters:

id - the uid of the content slot

catalogVersion - the catalog version

Returns:

Optional of the instance of the content slot if found and empty optional otherwise

getContentSlotByPageAndPosition

public java.util.Optional<ContentSlotModel> getContentSlotByPageAndPosition(java.lang.String position,
                                                                            AbstractPageModel page,
                                                                            CatalogVersionModel catalogVersion)

Description copied from interface: VendorCMSService

get content slot by its position, page and catalog version

Specified by:

getContentSlotByPageAndPosition in interface VendorCMSService

Parameters:

position - position of the content slot

page - page of the content slot

catalogVersion - the catalog version

Returns:

the expected content slot otherwise empty option

getCMSComponentByIdAndCatalogVersion

public java.util.Optional<AbstractCMSComponentModel> getCMSComponentByIdAndCatalogVersion(java.lang.String id,
                                                                                          CatalogVersionModel catalogVersion)

Description copied from interface: VendorCMSService

get component by its uid and catalog version

Specified by:

getCMSComponentByIdAndCatalogVersion in interface VendorCMSService

Parameters:

id - the uid of the component

catalogVersion - the catalog version

Returns:

Optional of the instance of the component if found and empty optional otherwise

getCMSComponentsByContentSlotAndCatalogVersions

public java.util.List<AbstractCMSComponentModel> getCMSComponentsByContentSlotAndCatalogVersions(java.lang.String contentSlotId,
                                                                                                 java.util.List<CatalogVersionModel> catalogVersions)

Description copied from interface: VendorCMSService

get component by content slot and catalog version

Specified by:

getCMSComponentsByContentSlotAndCatalogVersions in interface VendorCMSService

Parameters:

contentSlotId - Id of content slot

catalogVersions - list of catalog versions

Returns:

List of component in given content slot and catalog version

saveOrUpdateCMSVendorPage

public VendorPageModel saveOrUpdateCMSVendorPage(java.lang.String pageUid,
                                                 java.lang.String pageName,
                                                 CatalogVersionModel catalogVersion,
                                                 PageTemplateModel pageTemplate,
                                                 boolean isDefaultPage,
                                                 CmsApprovalStatus approvalStatus)

Description copied from interface: VendorCMSService

create an instance of CMS VendorPageModel

Specified by:

saveOrUpdateCMSVendorPage in interface VendorCMSService

Parameters:

pageUid - the page's uid

pageName - the page's name

catalogVersion - the catalogversion of this page

pageTemplate - the template of page used

isDefaultPage - using this page as a default?

approvalStatus - is approved or checked?

Returns:

The instance of the page

saveOrUpdateCMSVendorRestriction

public void saveOrUpdateCMSVendorRestriction(VendorModel vendor,
                                             CatalogVersionModel catalogVersion,
                                             java.lang.String uid,
                                             java.lang.String name,
                                             AbstractPageModel... pages)

Description copied from interface: VendorCMSService

create an instance of page restriction for a vendor

Specified by:

saveOrUpdateCMSVendorRestriction in interface VendorCMSService

Parameters:

vendor - the specific page

catalogVersion - the catalog version

uid - the restrication's ID

name - the restrication's name

pages - pages of restriction

saveOrUpdateCMSContentSlot

public ContentSlotModel saveOrUpdateCMSContentSlot(CatalogVersionModel catalogVersion,
                                                   java.lang.String uid,
                                                   java.lang.String name,
                                                   boolean active)

Description copied from interface: VendorCMSService

create content slot

Specified by:

saveOrUpdateCMSContentSlot in interface VendorCMSService

Parameters:

catalogVersion - the catalogversion of this page using

uid - content slot id

name - content slot name

active - is active?

Returns:

the content slot instance

saveOrUpdateCMSContentSlotForPage

public void saveOrUpdateCMSContentSlotForPage(CatalogVersionModel catalogVersion,
                                              java.lang.String uid,
                                              java.lang.String position,
                                              AbstractPageModel page,
                                              ContentSlotModel contentSlot)

Description copied from interface: VendorCMSService

create the content slot for a CMS page

Specified by:

saveOrUpdateCMSContentSlotForPage in interface VendorCMSService

Parameters:

catalogVersion - the catalogversion of this page using

uid - the id of this content slot

position - where is the content slot

page - the page of this content slot

contentSlot - detailed content slot reference

saveOrUpdateJspIncludeComponent

public JspIncludeComponentModel saveOrUpdateJspIncludeComponent(CatalogVersionModel catalogVersion,
                                                                java.lang.String uid,
                                                                java.lang.String name,
                                                                java.lang.String page)

Description copied from interface: VendorCMSService

create JSP include component

Specified by:

saveOrUpdateJspIncludeComponent in interface VendorCMSService

Parameters:

catalogVersion - the catalogversion of this page using

uid - the id of this component

name - name of the component

page - detailed jsp location of this component

Returns:

the instance of this jspincludecomponent

saveOrUpdateProductCarouselComponent

public ProductCarouselComponentModel saveOrUpdateProductCarouselComponent(CatalogVersionModel catalogVersion,
                                                                          java.lang.String uid,
                                                                          java.lang.String name,
                                                                          CarouselScroll scroll,
                                                                          boolean popup)

Description copied from interface: VendorCMSService

create product carousel component

Specified by:

saveOrUpdateProductCarouselComponent in interface VendorCMSService

Parameters:

catalogVersion - the catalog of this component

uid - the id of this component

name - the id of this component

scroll - how to scroll the carousel

popup - is pop-up?

Returns:

the instance of this component

getProductCarouselSynchronizationStatus

public SyncItemStatus getProductCarouselSynchronizationStatus(ProductCarouselComponentModel carousel)

Description copied from interface: VendorCMSService

Gets the synchronization item status for a given ProductCarouselComponentModel

Specified by:

getProductCarouselSynchronizationStatus in interface VendorCMSService

Parameters:

carousel - carousel model we are interested in getting the synchronization status

Returns:

the given carousel SyncItemStatus

performProductCarouselSynchronization

public void performProductCarouselSynchronization(ProductCarouselComponentModel carousel,
                                                  boolean synchronous)

Description copied from interface: VendorCMSService

Performs the synchronization of a model of ProductCarouselComponentModel taking in consideration the source and target catalog versions.

Specified by:

performProductCarouselSynchronization in interface VendorCMSService

Parameters:

carousel - the carousel model that we want to synchronize

synchronous - run with synchronous or asynchronous

getItemList

protected java.util.List<ItemModel> getItemList(ItemModel item)

getSyncRequestData

protected SyncRequestData getSyncRequestData(ProductCarouselComponentModel model)

getRelevantSyncItemJob

protected SyncItemJobModel getRelevantSyncItemJob(SyncRequestData syncRequestData,
                                                  ItemModel item)

isOutboundSynchronization

protected boolean isOutboundSynchronization(SyncRequestData syncRequestData,
                                            ItemModel item)

isExecutableInLocalView

protected boolean isExecutableInLocalView(SyncRequestData syncRequestData,
                                          ItemModel item)

getCmsPageTemplateDao

protected CMSPageTemplateDao getCmsPageTemplateDao()

setCmsPageTemplateDao

public void setCmsPageTemplateDao(CMSPageTemplateDao cmsPageTemplateDao)

getCmsPageDao

protected CMSPageDao getCmsPageDao()

setCmsPageDao

public void setCmsPageDao(CMSPageDao cmsPageDao)

getCmsRestrictionDao

protected CMSRestrictionDao getCmsRestrictionDao()

setCmsRestrictionDao

public void setCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao)

getCmsContentSlotDao

protected CMSContentSlotDao getCmsContentSlotDao()

setCmsContentSlotDao

public void setCmsContentSlotDao(CMSContentSlotDao cmsContentSlotDao)

getCmsComponentDao

protected MarketplaceCMSComponentDao getCmsComponentDao()

setCmsComponentDao

public void setCmsComponentDao(MarketplaceCMSComponentDao cmsComponentDao)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getSyncConfig

protected SyncConfig getSyncConfig()

setSyncConfig

public void setSyncConfig(SyncConfig syncConfig)

getSearchRestrictionService

protected SearchRestrictionService getSearchRestrictionService()

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getCatalogTypeService

protected CatalogTypeService getCatalogTypeService()

setCatalogTypeService

public void setCatalogTypeService(CatalogTypeService catalogTypeService)

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getPlatformSynchronizationStatusService

protected SynchronizationStatusService getPlatformSynchronizationStatusService()

setPlatformSynchronizationStatusService

public void setPlatformSynchronizationStatusService(SynchronizationStatusService platformSynchronizationStatusService)

getCatalogSynchronizationService

protected CatalogSynchronizationService getCatalogSynchronizationService()

setCatalogSynchronizationService

public void setCatalogSynchronizationService(CatalogSynchronizationService catalogSynchronizationService)