1 /**
2 * Copyright 2005-2012 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.kew.plugin;
17
18 /**
19 * Represents an entity which can be modified. A Modifiable records it's state when
20 * it's created. As long as the Modifiable remains in this state then invocations of
21 * isModified() should return false. If this state changes in a way which makes this
22 * Modifiable "dirty" then subsequent calls to isModified() should return true.
23 *
24 * <p>It is up to the implementor of the Modifiable to determine the contract between
25 * the Modifiable and the entities interested in it's modified status. This could
26 * include interested entities taking action on the Modifiable once it has become
27 * modified which result in it's modified status being reset. Another possibility is
28 * for a Modifiable to be discarded once it has been modified.
29 *
30 * @author Kuali Rice Team (rice.collab@kuali.org)
31 */
32 public interface Modifiable {
33
34 boolean isModified();
35
36 }