1 /**
2 * Copyright 2005-2015 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.web.bind;
17
18 import java.lang.annotation.ElementType;
19 import java.lang.annotation.Inherited;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * Indicates that the form annotated with this annotation has change tracking enabled.
26 *
27 * <p>Use this on a subclass of {@link org.kuali.rice.krad.web.form.UifFormBase} to enable this change tracking.
28 * Subclasses of a form with change tracking enabled can specify this annotation and {@code enabled = false} to disable
29 * changing tracking.
30 *
31 * @author Kuali Rice Team (rice.collab@kuali.org)
32 */
33 @Target(ElementType.TYPE)
34 @Retention(RetentionPolicy.RUNTIME)
35 @Inherited
36 public @interface ChangeTracking {
37
38 /**
39 * True if change tracking should be enabled for the annotated form, false if not.
40 *
41 * @return true if change tracking enabled, false otherwise
42 */
43 boolean enabled() default true;
44
45 }
46