@realestate/types/RESODataDictionaryV1_7/RuleFormat.d.ts

Types for real estate

/**
 * Copyright (c) 2023 ListBird. All Rights Reserved.
 *
 * This software product includes software or other works developed by RESO,
 * subject to the RESO End User License published at www.reso.org.
 *
 * Any modifications, derivative works, or redistributions of this source must
 * maintain this copyright notice. See the RESO EULA for more information.
 */

export enum RuleFormat {
  /**
   * {@link https://ddwiki.reso.org/display/DDW17/JavaScript}
   *
   * Business rules expressed utilizing the JavaScript language. The underlying structure of the rules are
   * not defined at this time and may vary from source to source.
   */
  Javascript = 'Javascript',

  /**
   * Business rules expressed utilizing the OData $filter syntax. The underlying structure of the rules are
   * not defined at this time and may vary from source to source.
   */
  OdataFilter = 'OdataFilter',

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/REBR}
   *
   * Real Estate Business Rule (REBR) notation, based on RuleSpeak structured notation, uses a predictable
   * syntax to allow humans to clearly and unambiguously specify real estate business rules. REBR is not
   * machine consumable and design for human production and consumption.
   */
  REBR = 'REBR',

  /**
   * {@link https://ddwiki.reso.org/display/DDW17/RetsValidation}
   *
   * Business rules expressed using the well defined RETS 1.9 Validation Expressions. See section 11.4.7 of
   * the RETS 1.9 Specification for additional details. https://www.reso.org/download/rets-1-9-specification/
   */
  RetsValidation = 'RetsValidation',
}