001/*
002 * (C) Copyright 2017 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Kevin Leturc
018 */
019package org.nuxeo.ecm.core.versioning;
020
021import java.util.HashMap;
022import java.util.Map;
023
024import org.nuxeo.common.xmap.annotation.XNode;
025import org.nuxeo.common.xmap.annotation.XNodeMap;
026import org.nuxeo.common.xmap.annotation.XObject;
027import org.nuxeo.ecm.core.api.DocumentModel;
028import org.nuxeo.ecm.core.api.VersioningOption;
029
030/**
031 * Descriptor to contribute new restrictions in versioning system.
032 * <p>
033 * These contributions will restrict available increment options on UI and raise an exception when saving a
034 * {@link DocumentModel} with an excluded {@link VersioningOption}.
035 *
036 * @since 9.1
037 */
038@XObject("restriction")
039public class VersioningRestrictionDescriptor {
040
041    @XNode("@type")
042    protected String type;
043
044    @XNodeMap(value = "options", key = "@lifeCycleState", type = HashMap.class, componentType = VersioningRestrictionOptionsDescriptor.class)
045    protected Map<String, VersioningRestrictionOptionsDescriptor> options = new HashMap<>();
046
047    public String getType() {
048        return type;
049    }
050
051    public VersioningRestrictionOptionsDescriptor getRestrictionOption(String key) {
052        return options.get(key);
053    }
054
055    public void merge(VersioningRestrictionDescriptor other) {
056        if (other.type != null) {
057            type = other.type;
058        }
059        options.putAll(other.options); // always merge options
060    }
061
062}