/**
 * Copyright © CENRA (2016)
 *
 * remi.clement@espaces-naturels.fr
 * 
 * This software is a multi-platform and portable application based on 
 * the scientifical toolbox to monitor wetlands. With this toolbox it’s 
 * possible to calculate indicators «RhoMéO» to monitor quality, 
 * fonctionalities and urban and agricultural pressures of wetlands. 
 * Indicators are calculated using naturalist data entered and/or imported,
 * and geographic data downloaded from a geographic server.
 * 
 * This software is governed by the CeCILL license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info". 
 * 
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability. 
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or 
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security. 
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
*/
package fr.cenra.rhomeo.core.data.site;

import fr.cenra.rhomeo.api.IdentifiedObject;
import javafx.collections.ObservableList;
import javax.validation.constraints.NotNull;
import org.hibernate.validator.constraints.NotBlank;


/**
 * Generic data access methods all project repositories should have.
 *
 * @author Cédric Briançon (Geomatys)
 * @param <I>
 */
public interface RhomeoRepository<I extends IdentifiedObject> {
    /**
     * Find the item for the given key.
     *
     * @param key An item key
     * @return The matching item, or {@code null} if not found.
     */
    I findOne(@NotBlank String key);

    /**
     * Create an item in the data source if the item key is not already present in the store,
     * otherwise throws {@link DuplicatedKeyException}.
     *
     * @param object The new item to create, should not be {@code null}
     * @throws DuplicatedKeyException if an object already exists with the same key
     */
    void create(@NotNull I object) throws DuplicatedKeyException;

    /**
     * Find all items in the data source.
     *
     * @return A list of items stored, eventually an empty list, never {@code null}
     */
    ObservableList<I> findAll();

    /**
     * Update an existing item in the data source. Its key should be the same in the
     * given object and in the stored version in order to know which item has to be updated.
     * If the given object key is not known in the store, then do nothing.
     *
     * @param object Item to update, with new values. Should not be {@code null}.
     */
    void update(@NotNull I object);

    /**
     * Update an existing item in the data source. The given object may have a new key specified,
     * so use the old key parameter to know which item should be updated.
     *
     * @param object Item to update, with new values. Should not be {@code null}.
     * @param oldKey Existing item key to update.
     * @throws DuplicatedKeyException if the given key in the object parameter is already used.
     */
    void update(@NotNull I object, String oldKey) throws DuplicatedKeyException;

    /**
     * Delete an existing item in the data source.
     *
     * @param key Key of the item to delete.
     */
    void delete(@NotBlank String key);
}
