001/**
002 * Copyright 2005-2018 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.web.bind;
017
018import java.lang.annotation.ElementType;
019import java.lang.annotation.Inherited;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Indicates that the form annotated with this annotation has change tracking enabled.
026 *
027 * <p>Use this on a subclass of {@link org.kuali.rice.krad.web.form.UifFormBase} to enable this change tracking.
028 * Subclasses of a form with change tracking enabled can specify this annotation and {@code enabled = false} to disable
029 * changing tracking.
030 *
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033@Target(ElementType.TYPE)
034@Retention(RetentionPolicy.RUNTIME)
035@Inherited
036public @interface ChangeTracking {
037
038    /**
039     * True if change tracking should be enabled for the annotated form, false if not.
040     *
041     * @return true if change tracking enabled, false otherwise
042     */
043    boolean enabled() default true;
044
045}
046