de.hybris.platform.btgcockpit.service.impl

Class DefaultBTGCockpitService

java.lang.Object

de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

de.hybris.platform.btgcockpit.service.impl.DefaultBTGCockpitService

All Implemented Interfaces:

BTGCockpitService

public class DefaultBTGCockpitService
extends AbstractServiceImpl
implements BTGCockpitService

Field Summary

Fields inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

modelService, typeService

Constructor Summary

Constructors

Constructor and Description
DefaultBTGCockpitService()

Method Summary

Modifier and Type	Method and Description
protected void	adjustContentSlotPositions(AbstractCMSComponentModel clonedComponent, AbstractCMSComponentModel sourceComponent) Moves the cloned component after the source component on all content slots
protected AbstractCMSComponentModel	cloneCompoenentFirstLevel(AbstractCMSComponentModel component)
TypedObject	createBtgSegment(String segmentName, TypedObject catalogVersion) Creates a btgSegment with the given name in the given catalogVersion.
protected BtgSegmentRestrictionModel	createBtgSegmentRestriction(CatalogVersionModel catalogVersionModel) Creates base instance of BtgSegmentRestrictionModel.
TypedObject	createCmsRestrictionAction(TypedObject segment, TypedObject restrictedCMSItem, boolean inverted) Creates a CMS Restriction Action with a according CMS Restriction and connects it with the segment and the CMS Item.
protected CMSInverseRestrictionModel	createInvertSegmentRestriction(AbstractRestrictionModel sourceRestriction, CatalogVersionModel catalogVersionModel) Creates an inverse restriction for given source restriction.
protected TypedObject	createPresonalizedPage(AbstractPageModel sourcePage, boolean cloneRestrictions, BTGSegmentModel segmentModel) Create personalized version of given page.
TypedObject	createShowItemOutputAction(RestrictionActionCreateContext context) Creates show item output action accordingly to given context.
protected BTGConfigurationService	getBtgConfigurationService()
TypedObject	getCatalogVersion(TypedObject segment) Get the catalog version for the specific BTGSegment
CmsCockpitService	getCmsCockpitService()
protected CMSSiteService	getCmsSiteService()
TypedObject	getDefaultBtgCatalogVersion() Gets the default catalog version for btg segments or null, if none configured.
GenericRandomNameProducer	getGenericRandomNameProducer()
List<TypedObject>	getOutputActions(TypedObject segment) Get the output actions for a specific BTGSegment
List<TypedObject>	getRules(TypedObject segment) Get the rules for a specific BTGSegment
protected AbstractRestrictionModel	invertRestriction(AbstractRestrictionModel sourceRestriction) Invert given restriction.
protected void	prepareComponentOutputActionDependencies(RestrictionActionCreateContext context, BtgSegmentRestrictionModel segmentRestriction) Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance.
protected void	prepareDefaultPageOutputActionDependencies(RestrictionActionCreateContext context, BtgSegmentRestrictionModel segmentRestriction, AbstractPageModel pageReference) Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance.
protected void	prepareNonDefaultPageOutputActionDependencies(RestrictionActionCreateContext context, BtgSegmentRestrictionModel segmentRestriction, AbstractPageModel pageReference) Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance.
protected AbstractRestrictionModel	prepareOutputActionDependencies(RestrictionActionCreateContext context, CmsRestrictionActionDefinitionModel outputAction, CatalogVersionModel catalogVersionModel) Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance.
protected void	preparePageOutputActionDependencies(RestrictionActionCreateContext context, BtgSegmentRestrictionModel segmentRestriction) Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance.
void	removeBTGOutputAction(TypedObject btgoutputAction) Removes the specific BTGOutputAction
void	removeBTGRule(TypedObject btgrule) Removes the specific BTGRule
void	removeBTGSegment(TypedObject btgsegment) Removes the specific BTGSegment
void	setBtgConfigurationService(BTGConfigurationService btgConfigurationService)
void	setCmsCockpitService(CmsCockpitService cmsCockpitService)
void	setCmsSiteService(CMSSiteService cmsSiteService)
void	setGenericRandomNameProducer(GenericRandomNameProducer genericRandomNameProducer)
void	setL10nService(L10NService l10nService)
void	setOutputActions(TypedObject segment, List<TypedObject> outputActions) Set the output actions for a specific BTGSegment
void	setRules(TypedObject segment, List<TypedObject> rules) Set the rules for a specific BTGSegment
void	setSegmentNameAccordingToFirstRule(TypedObject btgSegment) Sets the name of the segment according to the first rule.
void	setSystemService(SystemService systemService)

Methods inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

getEnum, getEnums, getLocalizedLabel, getLocalizedLabel, getModelService, getTypeService, setCockpitTypeService, setLabelResolver, setModelService

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBTGCockpitService

public DefaultBTGCockpitService()

Method Detail

removeBTGSegment

public void removeBTGSegment(TypedObject btgsegment)
                      throws ValueHandlerPermissionException

Description copied from interface: BTGCockpitService

Removes the specific BTGSegment

Specified by:

removeBTGSegment in interface BTGCockpitService

Parameters:

btgsegment - the BTGSegment to be removed

Throws:

ValueHandlerPermissionException

removeBTGRule

public void removeBTGRule(TypedObject btgrule)
                   throws ValueHandlerPermissionException

Description copied from interface: BTGCockpitService

Removes the specific BTGRule

Specified by:

removeBTGRule in interface BTGCockpitService

Parameters:

btgrule - the BTGRule to be removed

Throws:

ValueHandlerPermissionException

removeBTGOutputAction

public void removeBTGOutputAction(TypedObject btgoutputAction)
                           throws ValueHandlerPermissionException

Description copied from interface: BTGCockpitService

Removes the specific BTGOutputAction

Specified by:

removeBTGOutputAction in interface BTGCockpitService

Parameters:

btgoutputAction - the BTGOutputAction to be removed

Throws:

ValueHandlerPermissionException

getOutputActions

public List<TypedObject> getOutputActions(TypedObject segment)

Description copied from interface: BTGCockpitService

Get the output actions for a specific BTGSegment

Specified by:

getOutputActions in interface BTGCockpitService

Parameters:

segment - the BTGSegment

Returns:

the output actions, wrapped into TypedObjects

getRules

public List<TypedObject> getRules(TypedObject segment)

Description copied from interface: BTGCockpitService

Get the rules for a specific BTGSegment

Specified by:

getRules in interface BTGCockpitService

Parameters:

segment - the BTGSegment

Returns:

the rules, wrapped into TypedObjects

getCatalogVersion

public TypedObject getCatalogVersion(TypedObject segment)

Description copied from interface: BTGCockpitService

Get the catalog version for the specific BTGSegment

Specified by:

getCatalogVersion in interface BTGCockpitService

Parameters:

segment - the BTGSegment

Returns:

the catalog version, wrapped into TypedObject

setOutputActions

public void setOutputActions(TypedObject segment,
                             List<TypedObject> outputActions)

Description copied from interface: BTGCockpitService

Set the output actions for a specific BTGSegment

Specified by:

setOutputActions in interface BTGCockpitService

Parameters:

segment - the BTGSegment

outputActions - the output actions, wrapped into TypedObjects

setRules

public void setRules(TypedObject segment,
                     List<TypedObject> rules)

Description copied from interface: BTGCockpitService

Set the rules for a specific BTGSegment

Specified by:

setRules in interface BTGCockpitService

Parameters:

segment - the BTGSegment

rules - the rules, wrapped into TypedObjects

createShowItemOutputAction

public TypedObject createShowItemOutputAction(RestrictionActionCreateContext context)

Description copied from interface: BTGCockpitService

Creates show item output action accordingly to given context.

Note:
This creates a CmsRestrictionActionDefinition for a given segment RestrictionActionCreateContext.getCurrentSegment(), also creates a proper restriction base on context information.

Specified by:

createShowItemOutputAction in interface BTGCockpitService

Parameters:

context - given context information

Returns:

wrapped instance of CmsRestrictionActionDefinition

prepareComponentOutputActionDependencies

protected void prepareComponentOutputActionDependencies(RestrictionActionCreateContext context,
                                                        BtgSegmentRestrictionModel segmentRestriction)

Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance. This is invoked for ANY components.

Parameters:

context - given context information

segmentRestriction - output segment restriction

preparePageOutputActionDependencies

protected void preparePageOutputActionDependencies(RestrictionActionCreateContext context,
                                                   BtgSegmentRestrictionModel segmentRestriction)

Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance. This is invoked for ANY pages.

Parameters:

context - given context information

segmentRestriction - instance that will be created

prepareNonDefaultPageOutputActionDependencies

protected void prepareNonDefaultPageOutputActionDependencies(RestrictionActionCreateContext context,
                                                             BtgSegmentRestrictionModel segmentRestriction,
                                                             AbstractPageModel pageReference)

Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance. This is invoked for non default pages.

Parameters:

context - given context information

segmentRestriction - instance that will be created

pageReference - current page reference

prepareDefaultPageOutputActionDependencies

protected void prepareDefaultPageOutputActionDependencies(RestrictionActionCreateContext context,
                                                          BtgSegmentRestrictionModel segmentRestriction,
                                                          AbstractPageModel pageReference)

Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance. This is invoked for default pages.

Parameters:

context - given context information

segmentRestriction - instance that will be created

pageReference - current page reference

prepareOutputActionDependencies

protected AbstractRestrictionModel prepareOutputActionDependencies(RestrictionActionCreateContext context,
                                                                   CmsRestrictionActionDefinitionModel outputAction,
                                                                   CatalogVersionModel catalogVersionModel)

Creates all necessary dependencies in order to create a CmsRestrictionActionDefinitionModel instance.

Parameters:

context - given context information

outputAction - instance that will be created

catalogVersionModel - current catalog version

invertRestriction

protected AbstractRestrictionModel invertRestriction(AbstractRestrictionModel sourceRestriction)

Invert given restriction.

Note:
If source restriction is instance of CMSInverseRestrictionModel then should return the CMSInverseRestrictionModel.getOriginalRestriction() otherwise creates a CMSInverseRestrictionModel.

Parameters:

sourceRestriction - given source restriction

createBtgSegmentRestriction

protected BtgSegmentRestrictionModel createBtgSegmentRestriction(CatalogVersionModel catalogVersionModel)

Creates base instance of BtgSegmentRestrictionModel.

Parameters:

catalogVersionModel - given catalog version

createInvertSegmentRestriction

protected CMSInverseRestrictionModel createInvertSegmentRestriction(AbstractRestrictionModel sourceRestriction,
                                                                    CatalogVersionModel catalogVersionModel)

Creates an inverse restriction for given source restriction.

Parameters:

sourceRestriction - given source restriction

catalogVersionModel - given catalog version

createPresonalizedPage

protected TypedObject createPresonalizedPage(AbstractPageModel sourcePage,
                                             boolean cloneRestrictions,
                                             BTGSegmentModel segmentModel)

Create personalized version of given page.

Note:
Works in two different modes, first when cloneRestrictions is true the copy all properties of first level including restrictions, otherwise skip restrictions.

cloneCompoenentFirstLevel

protected AbstractCMSComponentModel cloneCompoenentFirstLevel(AbstractCMSComponentModel component)

adjustContentSlotPositions

protected void adjustContentSlotPositions(AbstractCMSComponentModel clonedComponent,
                                          AbstractCMSComponentModel sourceComponent)

Moves the cloned component after the source component on all content slots

getGenericRandomNameProducer

public GenericRandomNameProducer getGenericRandomNameProducer()

setGenericRandomNameProducer

public void setGenericRandomNameProducer(GenericRandomNameProducer genericRandomNameProducer)

getCmsCockpitService

public CmsCockpitService getCmsCockpitService()

setCmsCockpitService

public void setCmsCockpitService(CmsCockpitService cmsCockpitService)

createBtgSegment

public TypedObject createBtgSegment(String segmentName,
                                    TypedObject catalogVersion)

Description copied from interface: BTGCockpitService

Creates a btgSegment with the given name in the given catalogVersion.

Specified by:

createBtgSegment in interface BTGCockpitService

createCmsRestrictionAction

public TypedObject createCmsRestrictionAction(TypedObject segment,
                                              TypedObject restrictedCMSItem,
                                              boolean inverted)

Description copied from interface: BTGCockpitService

Creates a CMS Restriction Action with a according CMS Restriction and connects it with the segment and the CMS Item. CMS Sites related to the CMSItem will be added to the segments sites.

Specified by:

createCmsRestrictionAction in interface BTGCockpitService

Parameters:

segment - the segment to which the Restriction Action will be added.

restrictedCMSItem - the CMS Item (Page or Component) to which the restriction will be added.

inverted - if set to true, users from the segment will not see the CMS Item. Otherwise only users from the segment can see it.

Returns:

the newly created CmsRestrictionActionDefinitionModel, wrapped into a TypedObject

setSegmentNameAccordingToFirstRule

public void setSegmentNameAccordingToFirstRule(TypedObject btgSegment)

Description copied from interface: BTGCockpitService

Sets the name of the segment according to the first rule.

Specified by:

setSegmentNameAccordingToFirstRule in interface BTGCockpitService

setCmsSiteService

public void setCmsSiteService(CMSSiteService cmsSiteService)

getCmsSiteService

protected CMSSiteService getCmsSiteService()

setBtgConfigurationService

public void setBtgConfigurationService(BTGConfigurationService btgConfigurationService)

getBtgConfigurationService

protected BTGConfigurationService getBtgConfigurationService()

getDefaultBtgCatalogVersion

public TypedObject getDefaultBtgCatalogVersion()

Description copied from interface: BTGCockpitService

Gets the default catalog version for btg segments or null, if none configured.

Specified by:

getDefaultBtgCatalogVersion in interface BTGCockpitService

setSystemService

public void setSystemService(SystemService systemService)

setL10nService

public void setL10nService(L10NService l10nService)