View Javadoc
1   /*
2    * Copyright 2008 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.ole.sys.service;
17  
18  import java.sql.Date;
19  import java.util.List;
20  
21  import org.kuali.ole.sys.businessobject.TaxDetail;
22  import org.kuali.rice.core.api.util.type.KualiDecimal;
23  
24  public interface TaxService {
25      
26      /**
27       * This method returns a list of Tax Detail BO's for Sales Tax
28       * 
29       * @param dateOfTransaction date to include tax rates from
30       * @param postalCode postal code to get tax rates
31       * @param amount amount to be taxed
32       * @return
33       */
34      List<TaxDetail> getSalesTaxDetails( Date dateOfTransaction, String postalCode,  KualiDecimal amount );
35  
36      /**
37       * This method returns a list of Tax Detail BO's for Sales Tax
38       * 
39       * @param dateOfTransaction date to include tax rates from
40       * @param postalCode postal code to get tax rates
41       * @param amount amount to be taxed
42       * @return
43       */
44      List<TaxDetail> getUseTaxDetails( Date dateOfTransaction, String postalCode, KualiDecimal amount );
45  
46      /**
47       * This method returns the total sales tax amount
48       * 
49       * @param dateOfTransaction date to include tax rates from
50       * @param postalCode postal code to get tax rates
51       * @param amount amount to be taxed
52       * @return
53       */
54      KualiDecimal getTotalSalesTaxAmount( Date dateOfTransaction, String postalCode, KualiDecimal amount );
55  
56      /**
57       * This method returns pretaxAmount
58       * 
59       * @param dateOfTransaction date to include tax rates from
60       * @param postalCode postal code to get tax rates
61       * @param amount amount to be taxed
62       * @return
63       */
64      KualiDecimal getPretaxAmount(Date dateOfTransaction, String postalCode, KualiDecimal amountWithTax);
65  }