Package org.faktorips.runtime.productswitch

Interface MatchingProductFinder

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MatchingProductFinder

This functional interface represents an operation to find an IProductComponent for a given IConfigurableModelObject.

The functional method of this interface is findMatchingProduct(IConfigurableModelObject, List, List).

Since:

23.6

Method Summary

Modifier and Type	Method	Description
ProductFinderResult	findMatchingProduct(IConfigurableModelObject modelObject, List<IProductComponent> oldProducts, List<IProductComponent> newProducts)	This method returns a ProductFinderResult object which contains the correct replacement of an IProductComponent for the given IConfigurableModelObject.
default MatchingProductFinder	or(MatchingProductFinder other)	Returns a composed product finder that represents a short-circuiting logical OR of this product finder and another.

Method Details

findMatchingProduct

ProductFinderResult findMatchingProduct(IConfigurableModelObject modelObject,
 List<IProductComponent> oldProducts,
 List<IProductComponent> newProducts)

This method returns a ProductFinderResult object which contains the correct replacement of an IProductComponent for the given IConfigurableModelObject. Possible return values are:

• the correct replacement of a IProductComponent for the given IConfigurableModelObject
• ProductFinderResult.empty(String) if no suitable replacement was found
• ProductFinderResult.error(String) if no suitable replacement can be found, for example because the new parent product component has no children for the given association or there are multiple possible new targets. Details will be given in the ProductFinderResult.getMessage()

If no replacement was found, the result contains a message explaining why.

If more than one finder is chained with the or(MatchingProductFinder) method, the error result will stop the chain, while the empty result will delegate finding a replacement to the next finder.

Parameters:

modelObject - the model object that should be switched to a new IProductComponent

oldProducts - a list of IProductComponent objects found in the product configuration of the model object

newProducts - a list of IProductComponent objects found in the product configuration of the new IProductComponent

Returns:

a suitable replacement for the given model object from the newProducts list or an explanation why none was found

or

default MatchingProductFinder or(MatchingProductFinder other)

Returns a composed product finder that represents a short-circuiting logical OR of this product finder and another. When evaluating the composed product finder, if this product finder is present or has an error, then the other product finder is not evaluated.

Parameters:

other - a product finder that will be logically-ORed with this product finder

Returns:

the result of this product finder, or if empty, the result of the other product finder