/*
 * Copyright (C) 2025  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.ui.tab;

/**
 * Interface for tabs that can have savable content.
 * Implements methods for managing changes and saving state.
 */
public interface ISavableTab {

    /**
     * Retrieves the title to display when referring to the savable content of the tab.
     *
     * @return The save title associated with the tab content.
     */
    String getSaveTitle();

    /**
     * Checks if this tab has any unsaved changes
     *
     * @return true if there are unsaved changes, false otherwise
     */
    boolean hasUnsavedChanges();

    /**
     * Saves any pending changes in this tab
     *
     * @return true if save was successful, false if save failed
     */
    boolean saveChanges();

    /**
     * Discards any unsaved changes in this tab and reverts to the last saved state
     */
    void discardChanges();

}