package gw.forms

uses gw.api.productmodel.PolicyLinePattern
uses gw.validation.PCValidationBase

interface GenericFormInferenceBase {

  /**
   * @return the label displayed in the "Form inference conditions" dropdown
   * menu (on the Inference card of the Policy Forms admin UI).
   */
  property get DisplayName() : String

  /**
   * @return a list of all PolicyLinePatterns for which this inference class
   * is valid. Use PolicyLinePatternLookup.getAll() if this class is valid for all
   * PolicyLinePatterns.
   */
  property get ValidPolicylines() : List<PolicyLinePattern>

  /**
   * Whether this inference class requires a PolicyLine.
   */
  property get PolicyLineRequired() : boolean

  /**
   * Validate FormPattern fields that are specific to this inference class.
   */
  function validateCustomFields(formPattern : FormPattern, validation : PCValidationBase)
}