001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 */
016package org.kuali.rice.krad.data.metadata;
017
018import org.kuali.rice.krad.data.provider.CompositeMetadataProvider;
019
020/**
021 * A component of {@link MetadataCommon} which specifies what to do when a duplicate data object, attribute, collection
022 * or reference is encountered during the merging performed by the {@link CompositeMetadataProvider}.
023 * 
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public enum MetadataMergeAction {
027        /**
028         * The default behavior. Unset attributes will be left alone.
029         */
030        MERGE,
031        /**
032         * If a match is found (same data object or attribute name), the existing object will be replaced completely by this
033         * one.
034         */
035        REPLACE,
036        /**
037         * If a match is found (same data object or attribute name), the existing object will be removed. (Any attribute
038         * except that forming the key (type or attribute name) can be left unset.)
039         */
040        REMOVE,
041        /**
042         * If a match is found (same data object or attribute name), the existing object will be left alone. The metadata
043         * object will only be included if there is not already an existing object.
044         */
045        NO_OVERRIDE
046}