com.adobe.cq.targetrecommendations.api.model

Interface RecommendationAlgorithmConfiguration

@ProviderType
public interface RecommendationAlgorithmConfiguration

Abstracts a Target Recommendation configuration information

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigurationAttribute() Extra configuration attribute for the algorithm
java.lang.String	getConfigurationDataSource() Data source for the selected algorithm.
java.lang.String	getConfigurationKey() Target Recommendation Algorithm configuration key (e.g.
java.lang.String	getConfigurationType() Algorithm type for the selected configuration key.
DayCountInterval	getDayCount() Interval to be taken into account by the algorithm.
java.util.List<RecommendationAlgorithmInclusionRule>	getInclusionRules() The inclusion rules for this algorithm.
int	getMinInventory() Minimum inventory value for this algorithm Needs to be non-negative to be taken into account.
double	getPriceRangeMax() Price range maximum value for products to be considered by this algorithm
double	getPriceRangeMin() Price range minimum value for products to be considered by this algorithm
java.lang.String	getProductConfidence() Product confidence configuration for 'fullDataOptimizing' type algorithms.

Method Detail

getConfigurationKey

java.lang.String getConfigurationKey()

Target Recommendation Algorithm configuration key (e.g. 'currentCategory')

Returns:

a String representation of the configuration key

getConfigurationType

java.lang.String getConfigurationType()

Algorithm type for the selected configuration key.

Returns:

a String representation of the algorithm type

getConfigurationDataSource

java.lang.String getConfigurationDataSource()

Data source for the selected algorithm. When not specified it is usually considered an MBox data source

Returns:

a String representation of algorithm data source

getConfigurationAttribute

java.lang.String getConfigurationAttribute()

Extra configuration attribute for the algorithm

Returns:

the String representing the configuration attribute

getDayCount

DayCountInterval getDayCount()

Interval to be taken into account by the algorithm.

Returns:

a DayCountInterval enum value containing the time interval

getPriceRangeMin

double getPriceRangeMin()

Price range minimum value for products to be considered by this algorithm

Returns:

the minimum price range value

getPriceRangeMax

double getPriceRangeMax()

Price range maximum value for products to be considered by this algorithm

Returns:

the maximum price range value

getProductConfidence

java.lang.String getProductConfidence()

Product confidence configuration for 'fullDataOptimizing' type algorithms. No effect for other algorithm types.

Returns:

the product confidence configuration string

getMinInventory

int getMinInventory()

Minimum inventory value for this algorithm Needs to be non-negative to be taken into account.

Returns:

the minimum inventory value

getInclusionRules

java.util.List<RecommendationAlgorithmInclusionRule> getInclusionRules()

The inclusion rules for this algorithm.

Returns:

a List containing RecommendationAlgorithmInclusionRule inclusion rules