1 /** 2 * This file Copyright (c) 2012-2018 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.ui.api.app.launcherlayout; 35 36 import info.magnolia.cms.security.User; 37 38 /** 39 * Manages the launcher layout displayed in the app launcher. Fires an {@link AppLauncherLayoutChangedEvent} on the 40 * system event bus when the layout changes. 41 * 42 * @see AppLauncherLayout 43 * @see AppLauncherLayoutChangedEvent 44 * @see AppLauncherLayoutChangedEventHandler 45 */ 46 public interface AppLauncherLayoutManager { 47 48 /** 49 * The same functionality as {@link #getLayoutForUser(info.magnolia.cms.security.User)} provided 50 * for the user currently set in the {@link info.magnolia.context.Context}. 51 * 52 * @deprecated since 5.4. Please use {@link #getLayoutForUser(User)} instead. 53 */ 54 @Deprecated 55 AppLauncherLayout getLayoutForCurrentUser(); 56 57 /** 58 * Returns the {@link AppLauncherLayout} for the specified user. The following principles apply: 59 * <ul> 60 * <li>empty groups or groups where the current user doesn't have access to any of the apps are not returned;</li> 61 * <li>disabled apps, apps that the user does not have access to and apps that are not present in the {@link info.magnolia.ui.api.app.registry.AppDescriptorRegistry} are not included;</li> 62 * <li>the returned object is also populated with {@link info.magnolia.ui.api.app.AppDescriptor} references for quick access.</li> 63 * </ul> 64 * 65 * @param user user object 66 * @return app-launcher layout which corresponds to the provided user 67 */ 68 AppLauncherLayout getLayoutForUser(User user); 69 70 /** 71 * Called to update the launcher layout when it has been changed in the repository. 72 */ 73 void setLayout(AppLauncherLayoutDefinition layout); 74 }