View Javadoc
1   /*
2    * *************************************************************************************************************************************************************
3    *
4    * blueHour: open source accounting
5    * http://tidalwave.it/projects/bluehour
6    *
7    * Copyright (C) 2013 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8    *
9    * *************************************************************************************************************************************************************
10   *
11   * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12   * You may obtain a copy of the License at
13   *
14   *     http://www.apache.org/licenses/LICENSE-2.0
15   *
16   * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17   * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
18   *
19   * *************************************************************************************************************************************************************
20   *
21   * git clone https://bitbucket.org/tidalwave/bluehour-src
22   * git clone https://github.com/tidalwave-it/bluehour-src
23   *
24   * *************************************************************************************************************************************************************
25   */
26  package it.tidalwave.accounting.model.spi;
27  
28  import javax.annotation.Nonnull;
29  import it.tidalwave.accounting.model.Invoice;
30  import it.tidalwave.accounting.model.Project;
31  import it.tidalwave.accounting.model.types.Money;
32  
33  /***************************************************************************************************************************************************************
34   *
35   * @author  Fabrizio Giudici
36   *
37   **************************************************************************************************************************************************************/
38  public interface InvoiceSpi extends Invoice
39    {
40      /***********************************************************************************************************************************************************
41       * Returns the id of the invoice.
42       *
43       * @return  the id
44       **********************************************************************************************************************************************************/
45      @Nonnull
46      public String getNumber();
47  
48      /***********************************************************************************************************************************************************
49       * Returns the project associated to this invoice.
50       *
51       * @return  the project
52       **********************************************************************************************************************************************************/
53      @Nonnull
54      public Project getProject();
55  
56      /***********************************************************************************************************************************************************
57       * Returns the earnings for this invoice.
58       *
59       * @return  the earnings
60       **********************************************************************************************************************************************************/
61      @Nonnull
62      public Money getEarnings();
63  
64      /***********************************************************************************************************************************************************
65       * Returns the tax associated to this invoice.
66       *
67       * @return  the tax
68       **********************************************************************************************************************************************************/
69      @Nonnull
70      public Money getTax();
71    }