Package net.pricefx.common.apibuilder.rebateagreement

Interface RATBuilder

public interface RATBuilder
Builder for a Rebate Agreement Template (RAT). Used from a Rebate Agreement Template logic to programmatically create Rebate Agreements from an existing agreement or from parameters.

  • Method Details

    • templateTypeId

      String templateTypeId()
      Returns:
      the template type id

    • targetRAUniqueName

      String targetRAUniqueName()
      Returns:
      the unique name of the target Rebate Agreement

    • fromExisting

      RATBuilder.RABuilder fromExisting(String RAuniqueName)
      Starts building a Rebate Agreement from an existing one.
      Parameters:
      RAuniqueName - the unique name of the existing Rebate Agreement
      Returns:
      a builder for the new Rebate Agreement

    • fromParams

      RATBuilder.RABuilder fromParams(Map params)
      Starts building a Rebate Agreement from parameters.
      Parameters:
      params - the parameters
      Returns:
      a builder for the new Rebate Agreement

    • registerPlaceholder

      RATBuilder registerPlaceholder(InputType type, String name)
      Registers a placeholder that can later be applied with RATBuilder.RABuilder.applyPlaceholder(String, Object).
      Parameters:
      type - the input type of the placeholder
      name - the placeholder name
      Returns:
      itself

    • placeholders

      List<RATPlaceholder> placeholders()
      Returns:
      the registered placeholders