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, Class<? extends ProductModel>... clazzes) Deprecated. 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.
List<BundleTemplateModel>	getAllApprovedRootBundleTemplates(CatalogVersionModel catalogVersion) This methods returns all approved root bundle templates.
List<BundleTemplateModel>	getAllComponentsOfType(BundleTemplateModel bundleTemplate, Class<? extends ProductModel>... clazzes) Deprecated. 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.
List<BundleTemplateModel>	getAllRootBundleTemplates(CatalogVersionModel catVer) This methods returns all root bundle templates.
BundleTemplateModel	getBundleTemplateForCode(String bundleId) This method returns the bundle template by bundle id bundleId
BundleTemplateModel	getBundleTemplateForCode(String bundleId, String version) This method returns the bundle template by bundle id bundleId
List<BundleTemplateModel>	getBundleTemplatesByProduct(ProductModel model) Get all components (child bundle templates) where the current device is included in the products list
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.
List<BundleTemplateModel>	getTemplatesForMasterOrderAndBundleNo(AbstractOrderModel masterAbstractOrder, int bundleNo) Returns the distinct BundleTemplateModels from the order entries that match the given filter criteria
boolean	isAutoPickComponent(BundleTemplateModel bundleTemplate) Checks if BundleTemplateModel has a selection criteria of AutoPickBundleSelectionCriteriaModel
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(String bundleId)

This method returns the bundle template by bundle id bundleId

Parameters:

bundleId - Bundle Id

Returns:

BundleTemplateModel BundleTemplateModel

getBundleTemplatesByProduct

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

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

List<BundleTemplateModel> getTemplatesForMasterOrderAndBundleNo(AbstractOrderModel masterAbstractOrder,
                                                                int bundleNo)

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(String bundleId,
                                             String version)

This method returns the bundle template by bundle id bundleId

Parameters:

bundleId - Bundle Id

version -

Returns:

BundleTemplateModel BundleTemplateModel

isAutoPickComponent

boolean isAutoPickComponent(BundleTemplateModel bundleTemplate)

Checks if BundleTemplateModel has a selection criteria of AutoPickBundleSelectionCriteriaModel

Parameters:

bundleTemplate -

Returns:

true if selection criteria is AutoPickBundleSelectionCriteriaModel, otherwise false

containsComponenentProductsOfType

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

Deprecated. 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

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
List<BundleTemplateModel> getAllComponentsOfType(BundleTemplateModel bundleTemplate,
                                                             Class<? extends ProductModel>... clazzes)

Deprecated. 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

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