Interface MerchandisingMetricRollupStrategy

All Known Implementing Classes:
BaseProductMerchandisingMetricRollupStrategy, NoRollupMerchandisingMetricRollupStrategy

public interface MerchandisingMetricRollupStrategy
An interface that defines a strategy for "rolling up" variants for merchandising metric calculations.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the display name of the rollup strategy.
    int
    Gets the relative order position of the given rollup strategy.
    getReportingGroup(InputDocument product, String fieldName)
    Gets the "rolled up" group that the given product should have its merchandising scores calculated against.
  • Method Details

    • getReportingGroup

      String getReportingGroup(InputDocument product, String fieldName) throws MerchandisingMetricRollupException
      Gets the "rolled up" group that the given product should have its merchandising scores calculated against.
      Parameters:
      product - - the product to calculate the "rolled up" reporting group for
      fieldName - - "rolled up" variant field name.
      Returns:
      - the "rolled up" reporting group for the given product
      Throws:
      MerchandisingMetricRollupException - if the reporting group could not be calculated for the product
    • getName

      String getName()
      Gets the display name of the rollup strategy.
      Returns:
      the display name of the rollup strategy
    • getOrder

      int getOrder()
      Gets the relative order position of the given rollup strategy. This is used to determine the position (relative to other strategies) of the strategy in the rollup strategy dropdown.
      Returns:
      the relative order position relative to other rollup strategies