1 /**
2 * This file Copyright (c) 2010-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.vaadin.integration.contentconnector;
35
36 /**
37 * Defines a node type to be displayed in a workbench.
38 */
39 public interface NodeTypeDefinition {
40
41 /**
42 * Specifies the the name of the node type. For instance <code>mgnl:content</code>.
43 *
44 * @see info.magnolia.jcr.util.NodeTypes
45 * @see org.apache.jackrabbit.JcrConstants
46 */
47 String getName();
48
49 /**
50 * Specifies the icon to use for this node type.
51 */
52 String getIcon();
53
54 /**
55 * Specifies whether to include only the exact node type and ignore sub types.
56 */
57 boolean isStrict();
58
59 /**
60 * Determines whether the current node will be displayed in lists and searches. I.e. a node type <code>mgnl:folder</code> will likely be excluded from being displayed in a "flat" list view, therefore its value will be <code>true</code>.
61 *
62 * @return <code>false</code> by default, unless diversely set.
63 */
64 boolean isHideInList();
65 }