1 /**
2 * This file Copyright (c) 2010-2013 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.workbench.definition;
35
36 import info.magnolia.ui.workbench.tree.drop.DropConstraint;
37
38 import java.io.Serializable;
39 import java.util.List;
40
41 /**
42 * Defines a workbench. Contains all elements which define a workbench configuration.
43 */
44 public interface WorkbenchDefinition extends Serializable {
45
46 String getName();
47
48 String getWorkspace();
49
50 /**
51 * @return the path configured as root for this workspace. If not specified, defaults to root ("/").
52 */
53 String getPath();
54
55 /**
56 * @return all configured NodeTypes.
57 */
58 List<NodeTypeDefinition> getNodeTypes();
59
60 /**
61 * @return whether properties should be displayed as well (or just nodes)
62 */
63 boolean isIncludeProperties();
64
65 /**
66 * @return whether nodes used by the system should be included, for instance nodes internal to the operations of the JCR implementation.
67 */
68 boolean isIncludeSystemNodes();
69
70 /**
71 * Define if this workbench is used for Dialog.
72 */
73 boolean isDialogWorkbench();
74
75 /**
76 * @return the property (or comma separated list of properties) to be applied when no other order is requested.
77 */
78 String getDefaultOrder();
79
80 /**
81 * Checks if workbench can edit tree view inplace.
82 *
83 * @return true, if workbench is editable
84 */
85 boolean isEditable();
86
87 /**
88 * @return the DropConstraint class used to handle drag&drop.
89 */
90 Class<? extends DropConstraint> getDropConstraintClass();
91
92 /**
93 * @return the list of configured views.<br>
94 */
95 List<ContentPresenterDefinition> getContentViews();
96
97 }