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.fp.document.service;
017    
018    import java.sql.Timestamp;
019    
020    import org.kuali.rice.kns.util.KualiDecimal;
021    
022    /**
023     * 
024     * This service interface defines the methods that a DisbursementVoucherTravelService implementation must provide.
025     * 
026     * Performs calculations of travel per diem and mileage amounts.
027     * 
028     */
029    public interface DisbursementVoucherTravelService {
030    
031        /**
032         * 
033         * Calculates the per diem travel amount.  
034         * 
035         * @param startDateTime The start date and time of the period of time we will calculate the per diem amount for.
036         * @param endDateTime The end date and time of the period of time we will calculate the per diem amount for.
037         * @param perDiemRate The per diem rate used to calculate the total amount.
038         * @return The per diem amount for the time period passed in and based on the rate given.
039         */
040        public KualiDecimal calculatePerDiemAmount(Timestamp startDateTime, Timestamp endDateTime, KualiDecimal perDiemRate);
041    
042        /**
043         * 
044         * Calculates the mileage travel amount.
045         * 
046         * @param totalMileage The total distance traveled.
047         * @param travelStartDate The start date of the travel.
048         * @return The mileage amount for the mileage given.
049         */
050        public KualiDecimal calculateMileageAmount(Integer totalMileage, Timestamp travelStartDate);
051    
052    }