/*
 * Copyright (C) 2026  Tim Zimmermann <tim@aglais.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.aglais.zms.db.core;

import org.aglais.zms.db.core.model.AncestryData;
import org.aglais.zms.db.core.model.Species;
import org.aglais.zms.db.core.model.User;

import java.util.List;
import java.util.Map;

/**
 * Listener for backup events, e.g. on backup loaded
 */
public interface IBackupListener {

    /**
     * Class for keeping information related to a backup
     *
     * @param version     The backup's version
     * @param timestamp   Backup creation timestamp
     * @param speciesList List of {@link Species} stored in the backup
     * @param ancestryMap Map containing {@link AncestryData} stored in the backup
     * @param userList    List of {@link User}s stored in the backup
     */
    record BackupInfo(int version, long timestamp, List<Species> speciesList,
                      Map<Species, List<AncestryData>> ancestryMap, List<User> userList) {
    }

    /**
     * Called when a backup was successfully loaded.
     *
     * @param backupInfo {@link BackupInfo} for the loaded backup
     * @return True if the backup should continue to be restored, false otherwise
     */
    boolean onBackupLoaded(BackupInfo backupInfo);

}
