001    /**
002     * Copyright 2005-2014 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     */
016    package org.kuali.rice.kns.document;
017    
018    import org.kuali.rice.kns.maintenance.Maintainable;
019    import org.kuali.rice.krad.bo.PersistableBusinessObject;
020    
021    /**
022     * Common interface for all maintenance documents.
023     */
024    public interface MaintenanceDocument extends org.kuali.rice.krad.maintenance.MaintenanceDocument {
025    
026        /**
027         * @return Maintainable which holds the new maintenance record
028         */
029        public Maintainable getNewMaintainableObject();
030    
031        /**
032         * @return Maintainable which holds the old maintenance record
033         */
034        public Maintainable getOldMaintainableObject();
035    
036        /**
037         * Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.
038         */
039        public PersistableBusinessObject getDocumentBusinessObject();
040        
041        /**
042         * @return boolean - indicates whether this is an edit or new maintenace document by the existence of an old maintainable
043         */
044        public boolean isOldBusinessObjectInDocument();
045    
046    }