ResultInterface.php

<?php
/**
 * @file
 * Contains  Drupal\facets\Result\ResultInterface.
 */

namespace Drupal\facets\Result;


use Drupal\Core\Url;

/**
 * The interface defining what a facet result should look like.
 */
interface ResultInterface {

  /**
   * Get the raw value as present in the index.
   *
   * @return string
   */
  public function getRawValue();

  /**
   * Get the display value as present in the index.
   *
   * @return string
   */
  public function getDisplayValue();

  /**
   * Get the count for the result.
   *
   * @return mixed
   */
  public function getCount();

  /**
   * Get the Url.
   *
   * @return Url
   */
  public function getUrl();

  /**
   * Set the url.
   *
   * @param Url $url
   */
  public function setUrl(Url $url);

  /**
   * Indicate that the value is active (selected).
   *
   * @param bool $active
   */
  public function setActiveState($active);

  /**
   * Returns true if the value is active (selected).
   *
   * @return bool $active
   */
  public function isActive();

  /**
   * Override the display value of a result.
   *
   * @param string $display_value
   *   Override display value
   */
  public function setDisplayValue($display_value);

}