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 java.time.Duration;
30 import java.time.LocalDate;
31 import it.tidalwave.accounting.model.Project;
32 import it.tidalwave.accounting.model.types.Money;
33
34 /***************************************************************************************************************************************************************
35 *
36 * @author Fabrizio Giudici
37 *
38 **************************************************************************************************************************************************************/
39 public interface ProjectSpi extends Project
40 {
41 /***********************************************************************************************************************************************************
42 *
43 **********************************************************************************************************************************************************/
44 @Nonnull
45 public String getName();
46
47 /***********************************************************************************************************************************************************
48 *
49 **********************************************************************************************************************************************************/
50 @Nonnull
51 public String getNumber();
52
53 /***********************************************************************************************************************************************************
54 *
55 **********************************************************************************************************************************************************/
56 @Nonnull
57 public String getNotes();
58
59 /***********************************************************************************************************************************************************
60 *
61 **********************************************************************************************************************************************************/
62 @Nonnull
63 public LocalDate getStartDate();
64
65 /***********************************************************************************************************************************************************
66 *
67 **********************************************************************************************************************************************************/
68 @Nonnull
69 public LocalDate getEndDate();
70
71 /***********************************************************************************************************************************************************
72 *
73 **********************************************************************************************************************************************************/
74 @Nonnull
75 public Duration getDuration();
76
77 /***********************************************************************************************************************************************************
78 *
79 **********************************************************************************************************************************************************/
80 @Nonnull
81 public Status getStatus();
82
83 /***********************************************************************************************************************************************************
84 *
85 **********************************************************************************************************************************************************/
86 @Nonnull
87 public Money getEarnings();
88
89 /***********************************************************************************************************************************************************
90 *
91 **********************************************************************************************************************************************************/
92 @Nonnull
93 public Money getBudget();
94
95 /***********************************************************************************************************************************************************
96 *
97 **********************************************************************************************************************************************************/
98 @Nonnull
99 public Money getInvoicedEarnings();
100
101 /***********************************************************************************************************************************************************
102 *
103 **********************************************************************************************************************************************************/
104 @Nonnull
105 public Money getHourlyRate();
106 }