Package de.hybris.platform.b2ctelcoservices.services

Interface TmaPoService

All Known Implementing Classes:

DefaultTmaPoService

public interface TmaPoService

Service handling business logic around TmaProductOfferingModel.

Since:

6.7

Method Summary

Modifier and Type	Method	Description
void	addPoChildToParent(TmaBundledProductOfferingModel parent, TmaProductOfferingModel child)	Adds a new TmaProductOfferingModel child to a TmaBundledProductOfferingModel parent.
Collection<TmaBundledProductOfferingModel>	getAllParents(TmaProductOfferingModel poModel)	Returns all parents for the given product offering.
TmaBundledProductOfferingModel	getBpoForCode(String code)	Returns a TmaBundledProductOfferingModel for the given code.
Optional<TmaBundledProdOfferOptionModel>	getBundledProdOfferOptionFor(TmaBundledProductOfferingModel bundledProductOffering, TmaProductOfferingModel productOffering)	Returns the bundled product offering option part of the provided bpo which is referred to the provided product offering.
Set<TmaProductSpecCharacteristicModel>	getConfigurableProductSpecCharacteristics(TmaProductOfferingModel productOffering)	Computes and returns the configurable TmaProductSpecCharacteristicModel of a given product.
Set<TmaProductSpecCharValueUseModel>	getConfigurableProductSpecCharValueUses(TmaProductOfferingModel productOffering)	Gets the configurable product spec characteristics value uses.
Optional<TmaProductOfferingGroupModel>	getGroupNextToProductGroup(TmaBundledProductOfferingModel bpo, TmaProductOfferingModel po)	Searches for the the group next to the group which contains the PO given as parameter; It returns: the group with index 0, if PO given as parameter is in a group with index higher than 0 or, the group with index 1, if PO given as parameter is in a group with index 0 or, empty Optional if no group is found.
List<TmaBundledProductOfferingModel>	getIntermediateBpos(TmaProductOfferingModel currentPo, TmaBundledProductOfferingModel targetBpo)	Returns the list of BPOs between the provided PO and the target BPO.
Optional<TmaProductOfferingGroupModel>	getOfferingGroupForPoAndBpo(TmaProductOfferingModel productOffering, TmaBundledProductOfferingModel parent)	Retrieves the TmaProductOfferingGroupModel for a given product inside the given TmaBundledProductOfferingModel parent.
Optional<TmaOperationalProductOfferingModel>	getOperationalProductOffering(TmaSubscribedProductAction action)	Returns the operational product corresponding to the specified action.
default Set<String>	getParentIdsFrom(TmaProductOfferingModel productOffering)	Returns the set of all parents product offering ids for a given product offering.
TmaProductOfferingModel	getPoForCode(String code)	Returns a TmaProductOfferingModel for the given code.
TmaProductOfferingModel	getPoForCodeAndPriceContext(String code, TmaPriceContext priceContext)	Returns a TmaProductOfferingModel for the given code and prices of the TmaProductOfferingModel based on the TmaPriceContextData
ProductModel	getProductOffering(String productCode, TmaSubscribedProductAction cartAction)	Returns a product offering for the given product code and cart action.
Set<TmaProductOfferingGroupModel>	getProductOfferingGroupsByProperties(Map<String,String> propertyPattern)	Returns the set of @{link TmaProductOfferingGroupModel} based on key and value in map where key is the property name and the value is the pattern value of the property
List<TmaProductOfferingModel>	getProductOfferings(CatalogVersionModel catalogVersion)	Returns product offering list for corresponding catalog version
SearchPageData<TmaProductOfferingModel>	getProductOfferings(Collection<CatalogVersionModel> catalogVersions, TmaProductOfferingSearchContext productOfferingSearchContext)	Deprecated, for removal: This API element is subject to removal in a future version. since 1911 - use getAllProducts method of ExportProductService instead
Set<TmaProductOfferingModel>	getProductOfferingsByProperties(Map<String,String> propertyPattern)	Returns the set of TmaProductOfferingModel based on key and value in map where key is the property name and the value is the pattern value of the property
List<TmaProductOfferingModel>	getProductsForCode(String code)	Return the list of TmaProductOfferingModel based on product code
List<TmaSimpleProductOfferingModel>	getSpoListForBpo(TmaBundledProductOfferingModel bundleProductOffering)	Returns the list of all child product offering TmaSimpleProductOfferingModel for a given bundled product offering.
List<TmaProductOfferingModel>	getSposAndFixedBposFor(TmaBundledProductOfferingModel bundledProductOffering)	Returns the list of all children product offerings TmaSimpleProductOfferingModel and TmaFixedBundledProductOfferingModel for a given bundled product offering.
boolean	isPoEligibleForProcessType(TmaProcessType processType, TmaProductOfferingModel product, TmaBundledProductOfferingModel bpo)	Verifies if the given product is eligible for the given process type.
boolean	isServiceRequestAction(TmaSubscribedProductAction action)	This method checks if the given cart action requires an operational product.
boolean	isValidChild(TmaProductOfferingModel child, TmaBundledProductOfferingModel parent)	Verifies if the given child is eligible to be attached on the given parent.
boolean	isValidParent(TmaProductOfferingModel product, TmaBundledProductOfferingModel parent)	Verifies if the given TmaBundledProductOfferingModel parent is a valid parent for the given product offering.
void	removePoChildFromParent(TmaBundledProductOfferingModel parent, TmaProductOfferingModel child)	Removes the link between TmaProductOfferingModel child and TmaBundledProductOfferingModel parent.
void	removeProductOffering(String id)	Removes the product offering by id.

Method Details

getPoForCode

TmaProductOfferingModel getPoForCode(String code)

Returns a TmaProductOfferingModel for the given code.

Parameters:

code - identifier of TmaProductOfferingModel

Returns:

TmaProductOfferingModel

addPoChildToParent

void addPoChildToParent(TmaBundledProductOfferingModel parent,
 TmaProductOfferingModel child)

Adds a new TmaProductOfferingModel child to a TmaBundledProductOfferingModel parent.

Parameters:

parent - bundled product offering under which the child is added

child - child to be added

removePoChildFromParent

void removePoChildFromParent(TmaBundledProductOfferingModel parent,
 TmaProductOfferingModel child)

Removes the link between TmaProductOfferingModel child and TmaBundledProductOfferingModel parent.

Parameters:

parent - bundled product offering from which the child is removed

child - product offering child to be removed

getAllParents

Collection<TmaBundledProductOfferingModel> getAllParents(TmaProductOfferingModel poModel)

Returns all parents for the given product offering.

Parameters:

poModel - product offering

Returns:

Collection of TmaBundledProductOfferingModel

getGroupNextToProductGroup

Optional<TmaProductOfferingGroupModel> getGroupNextToProductGroup(TmaBundledProductOfferingModel bpo,
 TmaProductOfferingModel po)

Searches for the the group next to the group which contains the PO given as parameter; It returns: the group with index 0, if PO given as parameter is in a group with index higher than 0 or, the group with index 1, if PO given as parameter is in a group with index 0 or, empty Optional if no group is found.

Parameters:

bpo - the TmaBundledProductOfferingModel

po - the TmaProductOfferingModel

Returns:

Optional of TmaProductOfferingGroupModel

isValidParent

boolean isValidParent(TmaProductOfferingModel product,
 TmaBundledProductOfferingModel parent)

Verifies if the given TmaBundledProductOfferingModel parent is a valid parent for the given product offering. A valid parent it not necessary a first direct parent, it can also be a parent of one of product parents.

Parameters:

product - the given product offering against the checks are made

parent - the given parent to be check if is valid

Returns:

true if all Set elements are valid product parents codes, false otherwise

getBpoForCode

TmaBundledProductOfferingModel getBpoForCode(String code)

Returns a TmaBundledProductOfferingModel for the given code.

Parameters:

code - identifier of TmaBundledProductOfferingModel

Returns:

TmaBundledProductOfferingModel

getOfferingGroupForPoAndBpo

Optional<TmaProductOfferingGroupModel> getOfferingGroupForPoAndBpo(TmaProductOfferingModel productOffering,
 TmaBundledProductOfferingModel parent)

Retrieves the TmaProductOfferingGroupModel for a given product inside the given TmaBundledProductOfferingModel parent.

Parameters:

productOffering - the TmaProductOfferingModel whose product offering group will be identified

parent - the TmaBundledProductOfferingModel used for filtering the product offering groups

Returns:

the TmaProductOfferingGroupModel configured for the given product if any

isPoEligibleForProcessType

boolean isPoEligibleForProcessType(TmaProcessType processType,
 TmaProductOfferingModel product,
 TmaBundledProductOfferingModel bpo)

Verifies if the given product is eligible for the given process type. Eligibility is performed considering the process types defined on the subscription price plans of the given product. If the BPO is given then the checks are performed against price plan overrides of the BPO where the product is defined as affected product.

Parameters:

processType - the process type that is going to be verified

product - the product checked if eligible for given process type

bpo - the BPO where product is part of

Returns:

true/ false depending on the eligibility of the given product for the process type

getPoForCodeAndPriceContext

TmaProductOfferingModel getPoForCodeAndPriceContext(String code,
 TmaPriceContext priceContext)

Returns a TmaProductOfferingModel for the given code and prices of the TmaProductOfferingModel based on the TmaPriceContextData

Parameters:

code - identifier of TmaProductOfferingModel

priceContext - priceContext TmaPriceContext to retrieve prices of the TmaProductOfferingModel

Returns:

TmaProductOfferingModel

getProductOfferings

@Deprecated(since="1911",
            forRemoval=true)
SearchPageData<TmaProductOfferingModel> getProductOfferings(Collection<CatalogVersionModel> catalogVersions,
 TmaProductOfferingSearchContext productOfferingSearchContext)

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

since 1911 - use getAllProducts method of ExportProductService instead

Finds the TmaProductOfferingModel for a given collection CatalogVersionModel and TmaProductOfferingSearchContext

Parameters:

catalogVersions - catalog versions used to query for products

productOfferingSearchContext - product search context object stores all attributes for search

Returns:

page of TmaProductOfferingModel wrapped on SearchResult

getConfigurableProductSpecCharacteristics

Set<TmaProductSpecCharacteristicModel> getConfigurableProductSpecCharacteristics(TmaProductOfferingModel productOffering)

Computes and returns the configurable TmaProductSpecCharacteristicModel of a given product.

Parameters:

productOffering - the product offering

Returns:

the configurable characteristics

getOperationalProductOffering

Optional<TmaOperationalProductOfferingModel> getOperationalProductOffering(TmaSubscribedProductAction action)

Returns the operational product corresponding to the specified action.

Parameters:

action - the action that should be supported by the operational product.

Returns:

The first operational product found that supports the given action, if any.

isServiceRequestAction

boolean isServiceRequestAction(TmaSubscribedProductAction action)

This method checks if the given cart action requires an operational product.

Parameters:

action - the input action to be checked.

Returns:

true if an operational Po is used; false otherwise

getProductOffering

ProductModel getProductOffering(String productCode,
 TmaSubscribedProductAction cartAction)

Returns a product offering for the given product code and cart action.

Parameters:

productCode - the code used for getting a PO if the action is keep

cartAction - the cart action

Returns:

the product offering for the product code and cart action.

Throws:

de.hybris.platform.servicelayer.exceptions.ModelNotFoundException - if no product offering is found.

IllegalArgumentException - if the cartAction is invalid.

getProductsForCode

List<TmaProductOfferingModel> getProductsForCode(String code)

Return the list of TmaProductOfferingModel based on product code

Parameters:

code - identifier of TmaProductOfferingModel

Returns:

TmaProductOfferingModel

getProductOfferingsByProperties

Set<TmaProductOfferingModel> getProductOfferingsByProperties(Map<String,String> propertyPattern)

Returns the set of TmaProductOfferingModel based on key and value in map where key is the property name and the value is the pattern value of the property

Parameters:

propertyPattern - map which has property as key and pattern as value

Returns:

Set of TmaProductOfferingModel

getProductOfferingGroupsByProperties

Set<TmaProductOfferingGroupModel> getProductOfferingGroupsByProperties(Map<String,String> propertyPattern)

Returns the set of @{link TmaProductOfferingGroupModel} based on key and value in map where key is the property name and the value is the pattern value of the property

Parameters:

propertyPattern - map which has propertyPattern as key and pattern as value

Returns:

Set of TmaProductOfferingGroupModel

getSpoListForBpo

List<TmaSimpleProductOfferingModel> getSpoListForBpo(TmaBundledProductOfferingModel bundleProductOffering)

Returns the list of all child product offering TmaSimpleProductOfferingModel for a given bundled product offering.

Parameters:

bundleProductOffering - the bundle product offering

Returns:

the child spos of the product offering

getProductOfferings

List<TmaProductOfferingModel> getProductOfferings(CatalogVersionModel catalogVersion)

Returns product offering list for corresponding catalog version

Parameters:

catalogVersion - for which product offerings will be retrieved

Returns:

List of TmaProductOfferingModel

getBundledProdOfferOptionFor

Optional<TmaBundledProdOfferOptionModel> getBundledProdOfferOptionFor(TmaBundledProductOfferingModel bundledProductOffering,
 TmaProductOfferingModel productOffering)

Returns the bundled product offering option part of the provided bpo which is referred to the provided product offering.

Parameters:

bundledProductOffering - The Bundled Product Offering

productOffering - The product offering

Returns:

The TmaBundledProdOfferOptionModel from the bpo which refers to the product offering

getIntermediateBpos

List<TmaBundledProductOfferingModel> getIntermediateBpos(TmaProductOfferingModel currentPo,
 TmaBundledProductOfferingModel targetBpo)

Returns the list of BPOs between the provided PO and the target BPO.

Parameters:

currentPo - The product offering

targetBpo - The target bundled product offering

Returns:

List of TmaBundledProductOfferingModel

isValidChild

boolean isValidChild(TmaProductOfferingModel child,
 TmaBundledProductOfferingModel parent)

Verifies if the given child is eligible to be attached on the given parent. Eligible means that child must be a SPO either a Fixed BPO if the parent is a Fixed BPO

Parameters:

child - The PO which is going to be checked if it is eligible for attaching on a Fixed BPO

parent - The BPO depending on we know if the child PO is eligible or not

Returns:

true/ false depending on the eligibility of the given product offering

getSposAndFixedBposFor

List<TmaProductOfferingModel> getSposAndFixedBposFor(TmaBundledProductOfferingModel bundledProductOffering)

Returns the list of all children product offerings TmaSimpleProductOfferingModel and TmaFixedBundledProductOfferingModel for a given bundled product offering.

Parameters:

bundledProductOffering - the bundle product offering

Returns:

the child spos or fixed bpos of the product offering

getParentIdsFrom

default Set<String> getParentIdsFrom(TmaProductOfferingModel productOffering)

Returns the set of all parents product offering ids for a given product offering.

Parameters:

productOffering - the product offering

Returns:

A set containing the parents ids of the product offering

getConfigurableProductSpecCharValueUses

Set<TmaProductSpecCharValueUseModel> getConfigurableProductSpecCharValueUses(TmaProductOfferingModel productOffering)

Gets the configurable product spec characteristics value uses.

Parameters:

productOffering - the product offering

Returns:

the configurable product spec characteristics value uses

removeProductOffering

void removeProductOffering(String id)

Removes the product offering by id.

Parameters:

id - the id of the product offering .