1 /**
2 * This file Copyright (c) 2013-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.admincentral.shellapp.favorites;
35
36 import info.magnolia.ui.vaadin.integration.jcr.AbstractJcrNodeAdapter;
37 import info.magnolia.ui.vaadin.integration.jcr.JcrNewNodeAdapter;
38
39 import java.util.Map;
40
41 /**
42 * Manages the favorites for the current user.
43 */
44 public interface FavoritesManager {
45
46 AbstractJcrNodeAdapter getFavorites();
47
48 /**
49 * @return A map whose key is the group jcr name and whose value is its title (human-readable) property. The map elements are sorted alphabetically (descending) by their value.
50 */
51 Map<String, String> getGroupsNames();
52
53 void addFavorite(JcrNewNodeAdapter newFavorite);
54
55 JcrNewNodeAdapter createFavoriteSuggestion(String location, String title, String icon);
56
57 void removeFavorite(String relPath);
58
59 void editFavorite(String relPath, String newTitle);
60
61 void addGroup(JcrNewNodeAdapter newGroup);
62
63 void editGroup(String relPath, String newTitle);
64
65 void removeGroup(String relPath);
66
67 JcrNewNodeAdapter createFavoriteGroupSuggestion(String title);
68
69 void moveFavorite(String relPath, String group);
70
71 void orderFavoriteBefore(String relPath, String sibling);
72
73 void orderFavoriteAfter(String relPath, String sibling);
74
75 void orderGroupBefore(String relPath, String sibling);
76
77 void orderGroupAfter(String relPath, String sibling);
78 }