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.io.Serializable; 022import java.util.HashMap; 023import java.util.Map; 024 025import org.nuxeo.common.xmap.annotation.XNode; 026import org.nuxeo.common.xmap.annotation.XNodeMap; 027import org.nuxeo.common.xmap.annotation.XObject; 028import org.nuxeo.ecm.core.api.DocumentModel; 029import org.nuxeo.ecm.core.api.VersioningOption; 030 031/** 032 * Descriptor to contribute new restrictions in versioning system. 033 * <p /> 034 * These contributions will restrict available increment options on UI and raise an exception when saving a 035 * {@link DocumentModel} with an excluded {@link VersioningOption}. 036 * 037 * @since 9.1 038 */ 039@XObject("restriction") 040public class VersioningRestrictionDescriptor implements Serializable { 041 042 private static final long serialVersionUID = 1L; 043 044 @XNode("@type") 045 protected String type; 046 047 @XNodeMap(value = "options", key = "@lifeCycleState", type = HashMap.class, componentType = VersioningRestrictionOptionsDescriptor.class) 048 protected Map<String, VersioningRestrictionOptionsDescriptor> options = new HashMap<>(); 049 050 public String getType() { 051 return type; 052 } 053 054 public VersioningRestrictionOptionsDescriptor getRestrictionOption(String key) { 055 return options.get(key); 056 } 057 058 public void merge(VersioningRestrictionDescriptor other) { 059 if (other.type != null) { 060 type = other.type; 061 } 062 options.putAll(other.options); // always merge options 063 } 064 065}