<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace CommonsBooking\Geocoder\Provider;

use CommonsBooking\Geocoder\Collection;
use CommonsBooking\Geocoder\Query\GeocodeQuery;
use CommonsBooking\Geocoder\Query\ReverseQuery;

/**
 * Providers MUST always be stateless and immutable.
 *
 * @author William Durand <william.durand1@gmail.com>
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
interface Provider
{
    /**
     * @param GeocodeQuery $query
     *
     * @return Collection
     *
     * @throws \CommonsBooking\Geocoder\Exception\Exception
     */
    public function geocodeQuery(GeocodeQuery $query): Collection;

    /**
     * @param ReverseQuery $query
     *
     * @return Collection
     *
     * @throws \CommonsBooking\Geocoder\Exception\Exception
     */
    public function reverseQuery(ReverseQuery $query): Collection;

    /**
     * Returns the provider's name.
     *
     * @return string
     */
    public function getName(): string;
}
