<?php

namespace Dalten\RuianToUir\Converter\Result;

use Dalten\RuianToUir\Converter\Field\FieldInterface;

/**
 * Společné vlastnosti výsledku zpracování RUIAN záznamu.
 */
interface ResultInterface
{
    /**
     * Vrátí doplňková data k záznamu (název, vazby, atp.).
     *
     * Obecně to, co patří do databáze.
     *
     * @return array<string, scalar|FieldInterface|null>
     */
    public function getData(): array;

    /**
     * Vrátí typ záznamu. (County, Address, Region, ...).
     *
     * @return string
     */
    public function getItemType(): string;

    /**
     * Vrátí identifikátor (kód) záznamu.
     *
     * @return int
     */
    public function getIdentifier(): int;
}
