001    /*
002     * Copyright 2011 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.kfs.module.cam.document.service;
017    
018    import org.kuali.kfs.module.cam.businessobject.Asset;
019    import org.kuali.rice.kns.util.KualiDecimal;
020    
021    public interface PaymentSummaryService {
022        /**
023         * @param asset Asset that needs Payment Summary Information computed
024         *        <ol>
025         *        Computes following information and sets them to asset object
026         *        <li>Federal contribution amount</li>
027         *        <li>Payments till date</li>
028         *        <li>Total Cost of Asset</li>
029         *        <li>Accumulated Depreciation</li>
030         *        <li>Primary Base Amount</li>
031         *        <li>Book Value</li>
032         *        <li>Previous Year Depreciation</li>
033         *        <li>Year to Date Depreciation</li>
034         *        <li>Current month depreciation</li>
035         *        </ol>
036         */
037        void calculateAndSetPaymentSummary(Asset asset);
038    
039        /**
040         * Sums up federal contribution amount for an asset
041         * 
042         * @param asset Asset
043         * @return Federal Contribution Amount
044         */
045        KualiDecimal calculateFederalContribution(Asset asset);
046        
047        KualiDecimal calculatePrimaryAccumulatedDepreciation(Asset asset);
048        
049        KualiDecimal calculatePrimaryBookValue(Asset asset);
050        
051        KualiDecimal calculatePaymentTotalCost(Asset asset);
052    }