Package org.faktorips.runtime.productswitch

Interface AdvancedProductFinder

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 AdvancedProductFinder

This functional interface represents an operation to find an IProductComponent for a given IConfigurableModelObject. Unlike the MatchingProductFinder interface, this interface provides more options to find a replacement component.

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

Since:

23.6

Field Summary

Fields

Modifier and Type	Field	Description
static final AdvancedProductFinder	BY_KIND_ID	This AdvancedProductFinder uses the IProductComponent.getKindId() to find a suitable replacement for a product switch.

Method Summary

Modifier and Type	Method	Description
ProductFinderResult	findMatchingProduct(IConfigurableModelObject parent, IProductComponent oldParentProdCmpt, IConfigurableModelObject child, PolicyAssociation parentToChild)	This method returns a ProductFinderResult object which contains the correct replacement of an IProductComponent for the given IConfigurableModelObject.
default AdvancedProductFinder	or(AdvancedProductFinder other)	Returns a composed product finder that represents a short-circuiting logical OR of this product finder and other product finders.

Field Details

BY_KIND_ID

static final AdvancedProductFinder BY_KIND_ID

This AdvancedProductFinder uses the IProductComponent.getKindId() to find a suitable replacement for a product switch.

Method Details

findMatchingProduct

ProductFinderResult findMatchingProduct(IConfigurableModelObject parent,
 IProductComponent oldParentProdCmpt,
 IConfigurableModelObject child,
 PolicyAssociation parentToChild)

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(AdvancedProductFinder) method, the error result will stop the chain, while the empty result will delegate finding a replacement to the next finder.

Parameters:

parent - the parent model object

oldParentProdCmpt - the old IProductComponent, because the parent parameter already is set to the new product component

child - the child object for which a new IProductComponent must be found

parentToChild - the PolicyAssociation between parent and child

Returns:

a ProductFinderResult that represents a suitable replacement for the given model object or explains why none was found

or

default AdvancedProductFinder or(AdvancedProductFinder other)

Returns a composed product finder that represents a short-circuiting logical OR of this product finder and other product finders. 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