001/*
002 * Copyright 2008 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 */
016package org.kuali.ole.sys.service;
017
018import java.sql.Date;
019import java.util.List;
020
021import org.kuali.ole.sys.businessobject.TaxDetail;
022import org.kuali.rice.core.api.util.type.KualiDecimal;
023
024public interface TaxService {
025    
026    /**
027     * This method returns a list of Tax Detail BO's for Sales Tax
028     * 
029     * @param dateOfTransaction date to include tax rates from
030     * @param postalCode postal code to get tax rates
031     * @param amount amount to be taxed
032     * @return
033     */
034    List<TaxDetail> getSalesTaxDetails( Date dateOfTransaction, String postalCode,  KualiDecimal amount );
035
036    /**
037     * This method returns a list of Tax Detail BO's for Sales Tax
038     * 
039     * @param dateOfTransaction date to include tax rates from
040     * @param postalCode postal code to get tax rates
041     * @param amount amount to be taxed
042     * @return
043     */
044    List<TaxDetail> getUseTaxDetails( Date dateOfTransaction, String postalCode, KualiDecimal amount );
045
046    /**
047     * This method returns the total sales tax amount
048     * 
049     * @param dateOfTransaction date to include tax rates from
050     * @param postalCode postal code to get tax rates
051     * @param amount amount to be taxed
052     * @return
053     */
054    KualiDecimal getTotalSalesTaxAmount( Date dateOfTransaction, String postalCode, KualiDecimal amount );
055
056    /**
057     * This method returns pretaxAmount
058     * 
059     * @param dateOfTransaction date to include tax rates from
060     * @param postalCode postal code to get tax rates
061     * @param amount amount to be taxed
062     * @return
063     */
064    KualiDecimal getPretaxAmount(Date dateOfTransaction, String postalCode, KualiDecimal amountWithTax);
065}