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.api.availability;
35
36 import info.magnolia.cms.security.operations.AccessDefinition;
37
38 import java.util.Collection;
39
40 /**
41 * Definition of restrictions on when subject is available.
42 */
43 public interface AvailabilityDefinition {
44
45 /**
46 * If true the subject is available when there's no selection.
47 */
48 boolean isRoot();
49
50 /**
51 * If true the subject is available for properties.
52 */
53 boolean isProperties();
54
55 /**
56 * If true the subject is available for nodes.
57 */
58 boolean isNodes();
59
60 /**
61 * If true, the subject is available for multiple item selection.
62 */
63 boolean isMultiple();
64
65 /**
66 * Unless this is empty the subject is available only for these node types.
67 */
68 Collection<String> getNodeTypes();
69
70 /**
71 * Returns the AccessDefinition object for this subject.
72 */
73 AccessDefinition getAccess();
74
75 /**
76 * If true the subject is <i>only</i> available if write permission is granted for the item on which availability is evaluated.
77 */
78 boolean isWritePermissionRequired();
79
80 /**
81 * Returns the collection of availability rule definitions for this subject.
82 */
83 Collection<? extends AvailabilityRuleDefinition> getRules();
84 }