Package de.hybris.platform.configurablebundleservices.bundle.impl

Class DefaultBundleTemplateService

java.lang.Object

de.hybris.platform.configurablebundleservices.bundle.impl.DefaultBundleTemplateService

All Implemented Interfaces:

BundleTemplateService

public class DefaultBundleTemplateService
extends java.lang.Object
implements BundleTemplateService

Default implementation of the BundleTemplate service BundleTemplateService

Constructor Summary

Constructors

Constructor	Description
DefaultBundleTemplateService()

Method Summary

Modifier and Type	Method	Description
protected void	addGroupNumbers(java.util.List<EntryGroup> bundleEntryGroups, AbstractOrderModel order)
protected void	addTreeToOrder(AbstractOrderModel order, EntryGroup rootGroup)
EntryGroup	createBundleTree(BundleTemplateModel bundleTemplate, AbstractOrderModel order)	Creates entry group tree reflecting the structure of a bundle template and add the tree to the given order.
protected java.util.List<EntryGroup>	createEntryGroupTree(BundleTemplateModel currentBundleTemplate, EntryGroup parentEntryGroup)
java.util.List<BundleTemplateModel>	getAllApprovedRootBundleTemplates(CatalogVersionModel catalogVersion)	This methods returns all approved root bundle templates.
java.util.List<BundleTemplateModel>	getAllRootBundleTemplates(CatalogVersionModel catalogVersion)	This methods returns all root bundle templates.
protected AbstractBundleComponentEditableChecker<CartModel>	getBundleComponentEditableChecker()
EntryGroup	getBundleEntryGroup(AbstractOrderEntryModel entry)	Returns EntryGroup of type GroupType.CONFIGURABLEBUNDLE the given entry belongs to.
EntryGroup	getBundleEntryGroup(AbstractOrderModel order, java.util.Set<java.lang.Integer> entryGroupNumbers)	For given Set of entry group numbers find the one which id is of type CONFIGURABLEBUNDLE in given order.
protected BundleTemplateDao	getBundleTemplateDao()
BundleTemplateModel	getBundleTemplateForCode(java.lang.String bundleId)	This method returns the bundle template by bundle id bundleId
BundleTemplateModel	getBundleTemplateForCode(java.lang.String bundleId, java.lang.String version)	This method returns the bundle template by bundle id bundleId
java.lang.String	getBundleTemplateName(BundleTemplateModel bundleTemplate)	Get well-formatted string with the name of the given component.
java.util.List<BundleTemplateModel>	getBundleTemplatesByProduct(ProductModel model)	Get all components (child bundle templates) where the current device is included in the products list
protected EntryGroupService	getEntryGroupService()
java.util.List<BundleTemplateModel>	getLeafComponents(BundleTemplateModel anyComponent)	Collect all leaf components of bundle.
protected ModelService	getModelService()
int	getPositionInParent(BundleTemplateModel bundleTemplate)	Returns the given bundleTemplate's absolute position in the list of child templates that are assigned to the parent template
BundleTemplateModel	getPreviousBundleTemplate(BundleTemplateModel bundleTemplate)	Returns the previous child bundle template.
BundleTemplateModel	getRelativeBundleTemplate(BundleTemplateModel bundleTemplate, int relativePosition)	Returns a relative child bundle template.
BundleTemplateModel	getRootBundleTemplate(BundleTemplateModel bundleTemplateModel)	This method returns the root bundleTemplate BundleTemplateModel of the given bundleTemplateModel.
BundleTemplateModel	getSubsequentBundleTemplate(BundleTemplateModel bundleTemplate)	Returns the next child bundle template.
boolean	isAutoPickComponent(BundleTemplateModel bundleTemplate)	Checks if BundleTemplateModel has a selection criteria of auto pick type.
boolean	isBundleTemplateUsed(BundleTemplateModel bundleTemplate)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setBundleComponentEditableChecker(AbstractBundleComponentEditableChecker<CartModel> bundleComponentEditableChecker)
void	setBundleTemplateDao(BundleTemplateDao bundleTemplateDao)
void	setEntryGroupService(EntryGroupService entryGroupService)
void	setModelService(ModelService modelService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBundleTemplateService

public DefaultBundleTemplateService()

Method Detail

getRootBundleTemplate

@Nonnull
public BundleTemplateModel getRootBundleTemplate(@Nonnull
                                                 BundleTemplateModel bundleTemplateModel)

Description copied from interface: BundleTemplateService

This method returns the root bundleTemplate BundleTemplateModel of the given bundleTemplateModel. In case the given bundleTemplateModel is the root template the given bundleTemplateModel is returned as root template.

Specified by:

getRootBundleTemplate in interface BundleTemplateService

Parameters:

bundleTemplateModel - Bundle Template Model

Returns:

BundleTemplateModel

getBundleTemplateForCode

@Nonnull
public BundleTemplateModel getBundleTemplateForCode(@Nonnull
                                                    java.lang.String bundleId)

Description copied from interface: BundleTemplateService

This method returns the bundle template by bundle id bundleId

Specified by:

getBundleTemplateForCode in interface BundleTemplateService

Parameters:

bundleId - Bundle Id

Returns:

BundleTemplateModel BundleTemplateModel

getBundleTemplatesByProduct

@Nonnull
public java.util.List<BundleTemplateModel> getBundleTemplatesByProduct(@Nonnull
                                                                       ProductModel model)

Description copied from interface: BundleTemplateService

Get all components (child bundle templates) where the current device is included in the products list

Specified by:

getBundleTemplatesByProduct in interface BundleTemplateService

Parameters:

model - Product Model

Returns:

List - BundleTemplateModel

getSubsequentBundleTemplate

@Nullable
public BundleTemplateModel getSubsequentBundleTemplate(@Nonnull
                                                       BundleTemplateModel bundleTemplate)

Description copied from interface: BundleTemplateService

Returns the next child bundle template. The logic retrieves the parent of the given bundleTemplate and selects the parents next child template, e.g. SMAR_Handset (given bundleTemplate) -> SMAR (parent template) -> SMAR_Plan (next child template of parent), SMAR_Plan is returned.

Specified by:

getSubsequentBundleTemplate in interface BundleTemplateService

Parameters:

bundleTemplate - Bundle Template Model

Returns:

BundleTemplateModel

getPreviousBundleTemplate

@Nullable
public BundleTemplateModel getPreviousBundleTemplate(@Nonnull
                                                     BundleTemplateModel bundleTemplate)

Description copied from interface: BundleTemplateService

Returns the previous child bundle template. The logic retrieves the parent of the given bundleTemplate and selects the parents next child template, e.g. SMAR_Plan (given bundleTemplate) -> SMAR (parent template) -> SMAR_Handset (previous child template of parent), SMAR_Handset is returned.

Specified by:

getPreviousBundleTemplate in interface BundleTemplateService

Parameters:

bundleTemplate - Bundle Template Model

Returns:

BundleTemplateModel

getRelativeBundleTemplate

@Nullable
public BundleTemplateModel getRelativeBundleTemplate(@Nonnull
                                                     BundleTemplateModel bundleTemplate,
                                                     int relativePosition)

Description copied from interface: BundleTemplateService

Returns a relative child bundle template. The logic retrieves the parent of the given bundleTemplate and selects the parents relative child template

Specified by:

getRelativeBundleTemplate in interface BundleTemplateService

Parameters:

bundleTemplate - Bundle Template Model

relativePosition - the relative position of the child template to be returned

Returns:

BundleTemplateModel

getLeafComponents

@Nonnull
public java.util.List<BundleTemplateModel> getLeafComponents(@Nonnull
                                                             BundleTemplateModel anyComponent)

Description copied from interface: BundleTemplateService

Collect all leaf components of bundle.

Specified by:

getLeafComponents in interface BundleTemplateService

Parameters:

anyComponent - any component in bundle hierarchy

Returns:

list of leaf components in correct order

getPositionInParent

public int getPositionInParent(@Nonnull
                               BundleTemplateModel bundleTemplate)

Description copied from interface: BundleTemplateService

Returns the given bundleTemplate's absolute position in the list of child templates that are assigned to the parent template

Specified by:

getPositionInParent in interface BundleTemplateService

Parameters:

bundleTemplate - the child template whose position shall be returned

Returns:

absolute position as int

isAutoPickComponent

public boolean isAutoPickComponent(@Nullable
                                   BundleTemplateModel bundleTemplate)

Description copied from interface: BundleTemplateService

Checks if BundleTemplateModel has a selection criteria of auto pick type.

Specified by:

isAutoPickComponent in interface BundleTemplateService

Parameters:

bundleTemplate - Bundle Template Model

Returns:

true if selection criteria has auto pick type, otherwise false

getBundleTemplateForCode

@Nonnull
public BundleTemplateModel getBundleTemplateForCode(@Nonnull
                                                    java.lang.String bundleId,
                                                    @Nonnull
                                                    java.lang.String version)

Description copied from interface: BundleTemplateService

This method returns the bundle template by bundle id bundleId

Specified by:

getBundleTemplateForCode in interface BundleTemplateService

Parameters:

bundleId - Bundle Id

version - bundle version

Returns:

BundleTemplateModel BundleTemplateModel

isBundleTemplateUsed

@Deprecated(since="1905",
            forRemoval=true)
public boolean isBundleTemplateUsed(@Nonnull
                                    BundleTemplateModel bundleTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: BundleTemplateService

Checks if the given BundleTemplateModel was used in any cart or order entry

Specified by:

isBundleTemplateUsed in interface BundleTemplateService

Parameters:

bundleTemplate - Bundle Template Model

Returns:

true if given bundleTemplate is used in any cart/order entry, otherwise false

Since:

1905

getBundleTemplateName

@Nonnull
public java.lang.String getBundleTemplateName(BundleTemplateModel bundleTemplate)

Description copied from interface: BundleTemplateService

Get well-formatted string with the name of the given component.

Specified by:

getBundleTemplateName in interface BundleTemplateService

Parameters:

bundleTemplate - a bundle component

Returns:

the name of the component of component id (if the name is null)

getBundleEntryGroup

public EntryGroup getBundleEntryGroup(@Nonnull
                                      AbstractOrderEntryModel entry)

Description copied from interface: BundleTemplateService

Returns EntryGroup of type GroupType.CONFIGURABLEBUNDLE the given entry belongs to.

Specified by:

getBundleEntryGroup in interface BundleTemplateService

Parameters:

entry - entry to get group for

Returns:

entry group or null if the entry does not belong to any bundle groups

getBundleEntryGroup

public EntryGroup getBundleEntryGroup(AbstractOrderModel order,
                                      java.util.Set<java.lang.Integer> entryGroupNumbers)

Description copied from interface: BundleTemplateService

For given Set of entry group numbers find the one which id is of type CONFIGURABLEBUNDLE in given order.

Specified by:

getBundleEntryGroup in interface BundleTemplateService

Parameters:

order - Order to get bundle group for

entryGroupNumbers - List of Integers representing numbers of EntryGroups

Returns:

EntryGroup of type CONFIGURABLEBUNDLE in given order, referenced in entryGroupNumbers

createBundleTree

@Nonnull
public EntryGroup createBundleTree(@Nonnull
                                   BundleTemplateModel bundleTemplate,
                                   @Nonnull
                                   AbstractOrderModel order)

Description copied from interface: BundleTemplateService

Creates entry group tree reflecting the structure of a bundle template and add the tree to the given order.

Specified by:

createBundleTree in interface BundleTemplateService

Parameters:

bundleTemplate - any component of a bundle template

order - order to add the bundle to

Returns:

root EntryGroup of the structure created

createEntryGroupTree

protected java.util.List<EntryGroup> createEntryGroupTree(@Nonnull
                                                          BundleTemplateModel currentBundleTemplate,
                                                          EntryGroup parentEntryGroup)

addGroupNumbers

protected void addGroupNumbers(@Nonnull
                               java.util.List<EntryGroup> bundleEntryGroups,
                               @Nonnull
                               AbstractOrderModel order)

addTreeToOrder

protected void addTreeToOrder(@Nonnull
                              AbstractOrderModel order,
                              @Nonnull
                              EntryGroup rootGroup)

getBundleTemplateDao

protected BundleTemplateDao getBundleTemplateDao()

setBundleTemplateDao

public void setBundleTemplateDao(BundleTemplateDao bundleTemplateDao)

getBundleComponentEditableChecker

protected AbstractBundleComponentEditableChecker<CartModel> getBundleComponentEditableChecker()

setBundleComponentEditableChecker

public void setBundleComponentEditableChecker(AbstractBundleComponentEditableChecker<CartModel> bundleComponentEditableChecker)

getAllRootBundleTemplates

@Nonnull
public java.util.List<BundleTemplateModel> getAllRootBundleTemplates(CatalogVersionModel catalogVersion)

Description copied from interface: BundleTemplateService

This methods returns all root bundle templates.

Specified by:

getAllRootBundleTemplates in interface BundleTemplateService

Parameters:

catalogVersion - catalog version where bundle templates will be searched in

Returns:

List of BundleTemplateModels

getAllApprovedRootBundleTemplates

@Nonnull
public java.util.List<BundleTemplateModel> getAllApprovedRootBundleTemplates(CatalogVersionModel catalogVersion)

Description copied from interface: BundleTemplateService

This methods returns all approved root bundle templates.

Specified by:

getAllApprovedRootBundleTemplates in interface BundleTemplateService

Parameters:

catalogVersion - catalog version where bundle templates will be searched in

Returns:

List of BundleTemplateModels

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getEntryGroupService

protected EntryGroupService getEntryGroupService()

setEntryGroupService

public void setEntryGroupService(EntryGroupService entryGroupService)