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.kns.document;
17
18 import org.kuali.rice.kns.maintenance.Maintainable;
19 import org.kuali.rice.krad.bo.PersistableBusinessObject;
20
21 /**
22 * Common interface for all maintenance documents.
23 */
24 public interface MaintenanceDocument extends org.kuali.rice.krad.maintenance.MaintenanceDocument {
25
26 /**
27 * @return Maintainable which holds the new maintenance record
28 */
29 public Maintainable getNewMaintainableObject();
30
31 /**
32 * @return Maintainable which holds the old maintenance record
33 */
34 public Maintainable getOldMaintainableObject();
35
36 /**
37 * Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.
38 */
39 public PersistableBusinessObject getDocumentBusinessObject();
40
41 /**
42 * @return boolean - indicates whether this is an edit or new maintenace document by the existence of an old maintainable
43 */
44 public boolean isOldBusinessObjectInDocument();
45
46 }