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;
27
28 import javax.annotation.Nonnull;
29 import it.tidalwave.accounting.model.types.Money;
30 import it.tidalwave.util.Id;
31 import it.tidalwave.util.spi.ExtendedFinderSupport;
32
33 /***************************************************************************************************************************************************************
34 *
35 * @author Fabrizio Giudici
36 *
37 **************************************************************************************************************************************************************/
38 public interface InvoiceRegistry
39 {
40 /***********************************************************************************************************************************************************
41 *
42 **********************************************************************************************************************************************************/
43 public static interface Finder extends it.tidalwave.util.Finder<Invoice>, ExtendedFinderSupport<Invoice, InvoiceRegistry.Finder>
44 {
45 @Nonnull
46 public Finder withId (@Nonnull Id id);
47
48 @Nonnull
49 public Finder withProject (@Nonnull Project project);
50
51 @Nonnull
52 public Money getEarnings();
53 }
54
55 /***********************************************************************************************************************************************************
56 * Returns a {@link Finder} for finding {@link Invoice}s.
57 *
58 * @return the finder
59 **********************************************************************************************************************************************************/
60 @Nonnull
61 public Finder findInvoices();
62
63 /***********************************************************************************************************************************************************
64 * Returns an {@link Invoice.Builder} for adding a {@link Invoice} to the registry.
65 *
66 * @return the builder
67 **********************************************************************************************************************************************************/
68 @Nonnull
69 public Invoice.Builder addInvoice();
70 }