01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.php
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package edu.iu.uis.eden.plugin;
18:
19: /**
20: * Represents an entity which can be modified. A Modifiable records it's state when
21: * it's created. As long as the Modifiable remains in this state then invocations of
22: * isModified() should return false. If this state changes in a way which makes this
23: * Modifiable "dirty" then subsequent calls to isModified() should return true.
24: *
25: * <p>It is up to the implementor of the Modifiable to determine the contract between
26: * the Modifiable and the entities interested in it's modified status. This could
27: * include interested entities taking action on the Modifiable once it has become
28: * modified which result in it's modified status being reset. Another possibility is
29: * for a Modifiable to be discarded once it has been modified.
30: *
31: * @author Eric Westfall
32: */
33: public interface Modifiable {
34:
35: boolean isModified();
36:
37: }
|