/*
 * This file is part of Araknemu.
 *
 * Araknemu is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Araknemu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Araknemu.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Copyright (c) 2017-2019 Vincent Quatrevieux
 */

package fr.quatrevieux.araknemu.game.exploration.exchange;

import fr.quatrevieux.araknemu.core.event.ListenerAggregate;
import fr.quatrevieux.araknemu.game.exploration.creature.ExplorationCreature;
import fr.quatrevieux.araknemu.game.item.inventory.ItemEntry;
import org.checkerframework.checker.index.qual.NonNegative;
import org.checkerframework.checker.index.qual.Positive;

import java.util.Map;

/**
 * Base type for store data of an exchange
 */
public interface ExchangeStorage {
    /**
     * Get the current items on the exchange
     */
    public Map<ItemEntry, @Positive Integer> items();

    /**
     * Get the current kamas quantity on the exchange
     */
    public @NonNegative long kamas();

    /**
     * Get the accept state
     */
    public boolean accepted();

    /**
     * Get the dispatcher
     */
    public ListenerAggregate dispatcher();

    /**
     * Get the owner of the current exchange
     */
    public ExplorationCreature owner();
}