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 org.opencms.ui.components.CmsExtendedSiteSelector.SiteSelectorOption; 031import org.opencms.util.CmsUUID; 032 033import java.util.Optional; 034 035import com.vaadin.ui.Component; 036 037/** 038 * Interface the favorite dialog uses to interact with the rest of the application. 039 */ 040public interface I_CmsFavoriteContext { 041 042 /** 043 * Change the project to one with the given id. 044 * 045 * @param id the project id 046 */ 047 public void changeProject(CmsUUID id); 048 049 /** 050 * Changes current site. 051 * 052 * @param option the site selector option 053 */ 054 public void changeSite(SiteSelectorOption option); 055 056 /** 057 * Sets the dialog instance.<p> 058 * 059 * This must be called by the favorite dialog when it is loaded. 060 * 061 * @param component the favorite dialog 062 */ 063 public void setDialog(Component component); 064 065 /** 066 * Closes the favorite dialog. 067 */ 068 void close(); 069 070 /** 071 * Gets the favorite entry for the current location, as an Optional. 072 * 073 * If the result is empty, the current location can not be used as a favorite. 074 * 075 * @return an optional favorite entry 076 */ 077 Optional<CmsFavoriteEntry> getFavoriteForCurrentLocation(); 078 079 /** 080 * Opens the favorite location. 081 * 082 * @param entry the favorite entry whose location should be opened 083 */ 084 void openFavorite(CmsFavoriteEntry entry); 085 086}