001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.favorites;
029
030import java.util.Optional;
031
032import com.vaadin.ui.Component;
033
034/**
035 * Interface the favorite dialog uses to interact with the rest of the application.
036 */
037public interface I_CmsFavoriteContext {
038
039    /**
040     * Sets the dialog instance.<p>
041     *
042     * This must be called by the favorite dialog when it is loaded.
043     *
044     * @param component the favorite dialog
045     */
046    public void setDialog(Component component);
047
048    /**
049     * Closes the favorite dialog.
050     */
051    void close();
052
053    /**
054     * Gets the favorite entry for the current location, as an Optional.
055     *
056     * If the result is empty, the current location can not be used as a favorite.
057     *
058     * @return an optional favorite entry
059     */
060    Optional<CmsFavoriteEntry> getFavoriteForCurrentLocation();
061
062    /**
063     * Opens the favorite location.
064     *
065     * @param entry the favorite entry whose location should be opened
066     */
067    void openFavorite(CmsFavoriteEntry entry);
068
069}