001/**
002 * Copyright 2005-2015 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.datadictionary;
017
018import org.kuali.rice.krad.uif.util.CopyUtils;
019
020/**
021 * Marks KRAD framework objects that support deep copying.
022 * 
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public interface Copyable extends Cloneable {
026
027    /**
028     * Override {@link Object#clone()} to assign the public modifier.
029     * @return {@link Object#clone()}
030     * @throws CloneNotSupportedException If {@link Cloneable} is not implemented. This should not
031     *         be possible when using this interface.
032     * 
033     * @see CopyUtils#isUseClone() When cloning is enabled, {@link #clone} is used for shallow copy
034     *      operations.
035     * @see Cloneable
036     * @see Object#clone()
037     */
038    Object clone() throws CloneNotSupportedException;
039
040}