1 /**
2 * This file Copyright (c) 2019 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.availability.rule;
35
36 import info.magnolia.ui.api.availability.AvailabilityDefinition;
37 import info.magnolia.ui.api.availability.AvailabilityRule;
38 import info.magnolia.ui.api.availability.AvailabilityRuleDefinition;
39
40 import java.util.Collection;
41
42 import lombok.AccessLevel;
43 import lombok.AllArgsConstructor;
44 import lombok.Getter;
45
46 /**
47 * {@link info.magnolia.ui.api.availability.AvailabilityRule AvailabilityRule} implementation which returns true if current user has write permissions for the evaluated items.
48 */
49 @AllArgsConstructor
50 @Getter(AccessLevel.PROTECTED)
51 public abstract class AbstractAvailabilityRule<T, D extends AvailabilityRuleDefinition> implements AvailabilityRule {
52
53 private final AvailabilityDefinition availabilityDefinition;
54 private final D ruleDefinition;
55
56 @Override
57 public boolean isAvailable(Collection<?> items) {
58 if (shouldByPass(items)) {
59 return true;
60 }
61
62 for (Object item : items) {
63 if (!isAvailableForItem(item)) {
64 return this.ruleDefinition.getNegate();
65 }
66 }
67
68 return !this.ruleDefinition.getNegate();
69 }
70
71 /**
72 * Check whether the rule should even be tested against
73 * provided items.
74 *
75 * By default bail out on empty collection.
76 */
77 protected boolean shouldByPass(Collection<?> items) {
78 if (items.isEmpty()) {
79 return true;
80 }
81
82 return false;
83 }
84
85 protected boolean isAvailableForItem(Object item) {
86 return isAvailableFor((T) item);
87 }
88
89 protected abstract boolean isAvailableFor(T item);
90 }