de.hybris.platform.configurablebundleservices.bundle

Interface BundleTemplateService

All Known Implementing Classes:

DefaultBundleTemplateService

public interface BundleTemplateService

Bundle template service that exposes methods to deal with bundle template operations.

Spring Bean ID:

bundleTemplateService

Method Summary

Modifier and Type	Method and Description
boolean	containsComponenentProductsOfType(BundleTemplateModel bundleTemplate, java.lang.Class<? extends ProductModel>... clazzes) Deprecated. Since 6.0
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.
java.util.List<BundleTemplateModel>	getAllApprovedRootBundleTemplates(CatalogVersionModel catalogVersion) This methods returns all approved root bundle templates.
java.util.List<BundleTemplateModel>	getAllComponentsOfType(BundleTemplateModel bundleTemplate, java.lang.Class<? extends ProductModel>... clazzes) Deprecated. Since 6.0
java.util.List<BundleTemplateModel>	getAllRootBundleTemplates(CatalogVersionModel catVer) This methods returns all root bundle templates.
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.
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
java.util.List<BundleTemplateModel>	getLeafComponents(BundleTemplateModel anyComponent) Collect all leaf components of bundle.
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.
java.util.List<BundleTemplateModel>	getTemplatesForMasterOrderAndBundleNo(AbstractOrderModel masterAbstractOrder, int bundleNo) Deprecated. since 6.5 - bundleNo parameter is deprecated, should be replaced with entry groups
boolean	isAutoPickComponent(BundleTemplateModel bundleTemplate) Deprecated. since 1811 - auto pick component is a part of subscriptionbundles
boolean	isBundleTemplateUsed(BundleTemplateModel bundleTemplate) Checks if the given BundleTemplateModel was used in any cart or order entry

Method Detail

getRootBundleTemplate

BundleTemplateModel getRootBundleTemplate(BundleTemplateModel bundleTemplateModel)

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.

Parameters:

bundleTemplateModel -

Returns:

BundleTemplateModel

getBundleTemplateForCode

BundleTemplateModel getBundleTemplateForCode(java.lang.String bundleId)

This method returns the bundle template by bundle id bundleId

Parameters:

bundleId - Bundle Id

Returns:

BundleTemplateModel BundleTemplateModel

getBundleTemplatesByProduct

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

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

Parameters:

model -

Returns:

List - BundleTemplateModel

getSubsequentBundleTemplate

BundleTemplateModel getSubsequentBundleTemplate(BundleTemplateModel bundleTemplate)

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.

Parameters:

bundleTemplate -

Returns:

BundleTemplateModel

getPreviousBundleTemplate

BundleTemplateModel getPreviousBundleTemplate(BundleTemplateModel bundleTemplate)

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.

Parameters:

bundleTemplate -

Returns:

BundleTemplateModel

getRelativeBundleTemplate

BundleTemplateModel getRelativeBundleTemplate(BundleTemplateModel bundleTemplate,
                                              int relativePosition)

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

Parameters:

bundleTemplate -

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

Returns:

BundleTemplateModel

getLeafComponents

java.util.List<BundleTemplateModel> getLeafComponents(BundleTemplateModel anyComponent)

Collect all leaf components of bundle.

Parameters:

anyComponent - any component in bundle hierarchy

Returns:

list of leaf components in correct order

getTemplatesForMasterOrderAndBundleNo

@Deprecated
java.util.List<BundleTemplateModel> getTemplatesForMasterOrderAndBundleNo(AbstractOrderModel masterAbstractOrder,
                                                                                      int bundleNo)

Deprecated. since 6.5 - bundleNo parameter is deprecated, should be replaced with entry groups

Returns the distinct BundleTemplateModels from the order entries that match the given filter criteria

Parameters:

masterAbstractOrder - the master cart/order the bundle is in

bundleNo - the number of the bundle to which the bundle templates belong

Returns:

List of BundleTemplateModels or empty List.

getBundleTemplateForCode

BundleTemplateModel getBundleTemplateForCode(java.lang.String bundleId,
                                             java.lang.String version)

This method returns the bundle template by bundle id bundleId

Parameters:

bundleId - Bundle Id

version -

Returns:

BundleTemplateModel BundleTemplateModel

isAutoPickComponent

@Deprecated
boolean isAutoPickComponent(BundleTemplateModel bundleTemplate)

Deprecated. since 1811 - auto pick component is a part of subscriptionbundles

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

Parameters:

bundleTemplate -

Returns:

true if selection criteria has auto pick type, otherwise false

containsComponenentProductsOfType

@Deprecated
boolean containsComponenentProductsOfType(BundleTemplateModel bundleTemplate,
                                                      java.lang.Class<? extends ProductModel>... clazzes)

Deprecated. Since 6.0

Checks whether the products on the list of assigned products of the given bundleTemplate are of the the given clazzes.

The method is deprecated and should be replaced with own one on client side.

Parameters:

bundleTemplate - the component to be checked for add-on products

clazzes - class of the products instances that are on the list of assigned products of the given bundleTemplate (e.g. ServiceAddOnModel.class)

Returns:

true if the given bundleTemplate contains add-on products, otherwise false

getAllRootBundleTemplates

java.util.List<BundleTemplateModel> getAllRootBundleTemplates(CatalogVersionModel catVer)

This methods returns all root bundle templates.

Parameters:

catVer - catalog version where bundle templates will be searched in

Returns:

List of BundleTemplateModels

getAllComponentsOfType

@Deprecated
java.util.List<BundleTemplateModel> getAllComponentsOfType(BundleTemplateModel bundleTemplate,
                                                                       java.lang.Class<? extends ProductModel>... clazzes)

Deprecated. Since 6.0

Returns all child bundle templates (components) with products of the type clazz.

The method is deprecated and should be replaced with own one on client side.

Parameters:

bundleTemplate - the bundleTemplate for which the child components are searched

clazzes - class of the products instances that are on the list of assigned products of the searched bundleTemplate (e.g. ServicePlanModel.class)

Returns:

a list of the matching components

getPositionInParent

int getPositionInParent(BundleTemplateModel bundleTemplate)

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

Parameters:

bundleTemplate - the child template whose position shall be returned

Returns:

absolute position as int

getAllApprovedRootBundleTemplates

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

This methods returns all approved root bundle templates.

Parameters:

catalogVersion - catalog version where bundle templates will be searched in

Returns:

List of BundleTemplateModels

isBundleTemplateUsed

boolean isBundleTemplateUsed(BundleTemplateModel bundleTemplate)

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

Parameters:

bundleTemplate -

Returns:

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

getBundleTemplateName

java.lang.String getBundleTemplateName(BundleTemplateModel bundleTemplate)

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

Parameters:

bundleTemplate - a bundle component

Returns:

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

getBundleEntryGroup

EntryGroup getBundleEntryGroup(AbstractOrderEntryModel entry)

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

Parameters:

entry - entry to get group for

Returns:

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

getBundleEntryGroup

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.

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

Throws:

java.lang.IllegalArgumentException - when there is more than one group of the given type found

createBundleTree

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.

Parameters:

bundleTemplate - any component of a bundle template

order - order to add the bundle to

Returns:

root EntryGroup of the structure created