View Javadoc
1   /*
2    * MoneyWise: Finance Application
3    * Copyright 2012-2026. Tony Washer
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6    * use this file except in compliance with the License.  You may obtain a copy
7    * of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
14   * License for the specific language governing permissions and limitations under
15   * the License.
16   */
17  package io.github.tonywasher.joceanus.moneywise.tax;
18  
19  import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTax.MoneyWiseTaxCredit;
20  import io.github.tonywasher.joceanus.oceanus.decimal.OceanusMoney;
21  
22  import java.util.Iterator;
23  
24  /**
25   * UK Tax Analysis.
26   */
27  public interface MoneyWiseTaxAnalysis {
28      /**
29       * Obtain the taxYear.
30       *
31       * @return the taxYear
32       */
33      MoneyWiseTaxYearCtl getTaxYear();
34  
35      /**
36       * Obtain the taxableIncome.
37       *
38       * @return the taxableIncome
39       */
40      OceanusMoney getTaxableIncome();
41  
42      /**
43       * Obtain the taxDue.
44       *
45       * @return the taxDue
46       */
47      OceanusMoney getTaxDue();
48  
49      /**
50       * Obtain the taxPaid.
51       *
52       * @return the taxPaid
53       */
54      OceanusMoney getTaxPaid();
55  
56      /**
57       * Obtain the taxProfit.
58       *
59       * @return the taxProfit
60       */
61      OceanusMoney getTaxProfit();
62  
63      /**
64       * Obtain the taxBands iterator.
65       *
66       * @return the iterator
67       */
68      Iterator<MoneyWiseTaxDueBucket> taxDueIterator();
69  
70      /**
71       * TaxYear.
72       */
73      interface MoneyWiseTaxYearCtl
74              extends MoneyWiseTaxCredit {
75      }
76  }