Package de.hybris.platform.catalog.references

Interface ProductReferenceService

All Known Implementing Classes:

DefaultProductReferenceService

public interface ProductReferenceService

Service providing product references oriented functionality.

Method Summary

Modifier and Type	Method	Description
java.util.Collection<ProductReferenceModel>	getProductReferences(java.lang.String qualifier, ProductModel source, ProductModel target, boolean activeOnly)	Returns ProductReferenceModels that join the two given products in the given source/target configuration having the given ProductReferenceModel.QUALIFIER value.
java.util.Collection<ProductReferenceModel>	getProductReferencesForSourceAndTarget(ProductModel source, ProductModel target, boolean activeOnly)	Returns all ProductReferenceModels that join the two given products in the given (persisted) source/target configuration.
java.util.Collection<ProductReferenceModel>	getProductReferencesForSourceProduct(ProductModel source, ProductReferenceTypeEnum referenceType, boolean activeOnly)	Returns all ProductReferenceModels for the given (persisted) source ProductModel and for the specific ProductReferenceTypeEnum.
java.util.Collection<ProductReferenceModel>	getProductReferencesForTargetProduct(ProductModel target, ProductReferenceTypeEnum referenceType, boolean activeOnly)	Returns all ProductReferenceModels for the given (persisted) target ProductModel and for the specific ProductReferenceTypeEnum.

Method Detail

getProductReferencesForSourceProduct

java.util.Collection<ProductReferenceModel> getProductReferencesForSourceProduct(ProductModel source,
                                                                                 ProductReferenceTypeEnum referenceType,
                                                                                 boolean activeOnly)

Returns all ProductReferenceModels for the given (persisted) source ProductModel and for the specific ProductReferenceTypeEnum.

Example: Using ProductReferenceTypeEnum.ACCESSORIES returns the related (accessories) ProductReferenceModels, NOT the actual products (accessories), use ProductReferenceModel.getTarget() to get the actual accessory product.

Parameters:

source - the source ProductModel

referenceType - the type of the reference - ProductReferenceTypeEnum. If this argument is null, the productReferences of all types will be returned.

activeOnly - - if true, only active product references will be returned.

Returns:

a collection of ProductReferenceModels or an empty list if there are no source references for the given product

Throws:

java.lang.IllegalArgumentException - if source product is null.

getProductReferencesForTargetProduct

java.util.Collection<ProductReferenceModel> getProductReferencesForTargetProduct(ProductModel target,
                                                                                 ProductReferenceTypeEnum referenceType,
                                                                                 boolean activeOnly)

Returns all ProductReferenceModels for the given (persisted) target ProductModel and for the specific ProductReferenceTypeEnum.

Example: Using ProductReferenceTypeEnum.CROSSELLING returns the related (for cross selling) ProductReferenceModels, NOT the actual cross selled (source) products, use ProductReferenceModel.getSource() to get the source product of the cross selling.

Parameters:

target - the target ProductModel

referenceType - the type of the reference - ProductReferenceTypeEnum. If this argument is null, the productReferences of all types will be returned.

activeOnly - - if true, only active product references will be returned.

Returns:

a collection of ProductReferenceModels or empty list if there are no target references for the given product.

Throws:

java.lang.IllegalArgumentException - if target product is null.

getProductReferencesForSourceAndTarget

java.util.Collection<ProductReferenceModel> getProductReferencesForSourceAndTarget(ProductModel source,
                                                                                   ProductModel target,
                                                                                   boolean activeOnly)

Returns all ProductReferenceModels that join the two given products in the given (persisted) source/target configuration.

One can get multiple ProductReferenceModels as one product may reference another in different way (different ProductReferenceModel.REFERENCETYPE)

Example: two products can be joined by a reference of ProductReferenceTypeEnum.ACCESSORIES and ProductReferenceTypeEnum.CROSSELLING types, which means that one is an accessory of the other and - at the same time - they are configured in the cross-selling strategy.

Parameters:

source - the source ProductModel

target - the target ProductModel

activeOnly - - if true, only active Product references will be returned.

Returns:

Collection of the ProductReferenceModels or empty list.

Throws:

java.lang.IllegalArgumentException - if either source or target product is null.

getProductReferences

java.util.Collection<ProductReferenceModel> getProductReferences(java.lang.String qualifier,
                                                                 ProductModel source,
                                                                 ProductModel target,
                                                                 boolean activeOnly)

Returns ProductReferenceModels that join the two given products in the given source/target configuration having the given ProductReferenceModel.QUALIFIER value.

Parameters:

qualifier - the desired ProductReferenceModel.QUALIFIER. If this argument is null or empty string, it will be ignored as a search criterion.

source - the source ProductModel

target - the target ProductModel

activeOnly - - if true, only active Product references will be returned.

Returns:

Collection of the ProductReferenceModels or empty list.

Throws:

java.lang.IllegalArgumentException - if either source or target product is null.