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

package com.hardbacknutter.nevertoomanybooks.searchengines;

import android.content.Context;

import com.hardbacknutter.nevertoomanybooks.entities.codes.ProductCode;

/**
 * An object of this type is created during a call
 * to {@link SearchEngine.AlternativeEditions#searchAlternativeEditions(Context, ProductCode)}.
 * <p>
 * Depending on the concrete type, it will be used to fetch alternative editions of
 * the requested book, or to fetch alternative covers.
 */
public interface AltEdition {

    /**
     * This edition <strong>MAY</strong> have a cover.
     *
     * @return {@code false} if we are certain this edition has no cover.
     *         {@code true} if a search should be done
     */
    default boolean mayHaveCover() {
        return true;
    }
}
