package gw.rating.rtm.query

uses gw.api.rating.RateQueryResult
uses gw.rating.rtm.matchop.StatelessMatchOperator

uses java.lang.Comparable
uses java.util.Map
uses java.util.List

@ReadOnly
interface RatingQuery {

  function queryMultipleFactors(table : RateTable, inputParams : Comparable[], factorCodes : List<String>)
      : Map<String, Object>

  function convertAndQueryMultipleFactors(table : RateTable, inputParams : Comparable[]) : Map<String, Object>

  property get MatchOps() : List<StatelessMatchOperator>

  @Deprecated(:value="Use version that takes Comparable array instead of list", :version="8.0.1")
  reified function query<R>(table : RateTable, inputParams : List<RateQueryParam>, factorCode : String) : RateQueryResult<R>

  @Deprecated(:value="Use version that takes Comparable array instead of list", :version="8.0.1")
  reified function query<R>(table : RateTable, inputParams : Map<String, RateQueryParam>, factorCode : String) : RateQueryResult<R>

  /**
   * Perform the query for a single factor.
   *
   * @param table the <code>RateTable</code> to query
   * @param convertedInputParams Array of <code>Comparable</code> that is used to match against match operations that are defined for the table
   * @param factorCode code for single factor that is desired in the result.  Null may be passed to get the default factor.
   *
   * @return the result factor
   */
  reified function query<R>(table : RateTable, convertedInputParams : Comparable[], factorCode : String) : RateQueryResult<R>

  /**
   * Perform the query for a single factor.   Unlike query()--which requires the input params to have been run through
   * their respective matchop's parameter conversions--this function does the conversion on behalf of the caller.
   *
   * @param table the <code>RateTable</code> to query
   * @param inputParams Array of <code>Comparable</code> that is used to match against match operations that are defined for the table
   * @param factorCode code for single factor that is desired in the result.  Null may be passed to get the default factor.
   *
   * @return the result factor
   */
  reified function convertParamsAndQuery<R>(table : RateTable, inputParams : Comparable[], factorCode : String) : RateQueryResult<R>

  /**
   * Perform the query and return the result for the first factor sorted by SortOrder.
   *
   * @param table the <code>RateTable</code> to query
   * @param inputParams Array of <code>Comparable</code> that is used to match against match operations that are defined for the table
   *
   * @return the result factor
   */
  reified function query<R>(table : RateTable, inputParams : Comparable[]) : RateQueryResult<R>

}