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 java.time.Duration;
30 import it.tidalwave.accounting.model.Project.Builder;
31 import it.tidalwave.accounting.model.types.Money;
32 import it.tidalwave.util.Finder;
33 import it.tidalwave.util.Id;
34 import it.tidalwave.util.spi.ExtendedFinderSupport;
35
36 /***************************************************************************************************************************************************************
37 *
38 * @author Fabrizio Giudici
39 *
40 **************************************************************************************************************************************************************/
41 public interface ProjectRegistry
42 {
43 public static final Class<ProjectRegistry> CustomerRegistry = ProjectRegistry.class;
44
45 /***********************************************************************************************************************************************************
46 *
47 **********************************************************************************************************************************************************/
48 public static interface ProjectFinder extends Finder<Project>, ExtendedFinderSupport<Project, ProjectFinder>
49 {
50 @Nonnull
51 public ProjectFinder withId (@Nonnull Id id);
52 }
53
54 /***********************************************************************************************************************************************************
55 *
56 **********************************************************************************************************************************************************/
57 public static interface JobEventFinder extends Finder<JobEvent>, ExtendedFinderSupport<JobEvent, JobEventFinder>
58 {
59 @Nonnull
60 public JobEventFinder withId (@Nonnull Id id);
61
62 @Nonnull
63 public Duration getDuration();
64
65 @Nonnull
66 public Money getEarnings();
67 }
68
69 /***********************************************************************************************************************************************************
70 * Returns a {@link ProjectFinder} for finding {@link Project}s.
71 *
72 * @return the finder
73 **********************************************************************************************************************************************************/
74 @Nonnull
75 public ProjectFinder findProjects();
76
77 /***********************************************************************************************************************************************************
78 * Returns a {@link ProjectFinder} for finding {@link JobEvent}s.
79 *
80 * @return the finder
81 **********************************************************************************************************************************************************/
82 @Nonnull
83 public JobEventFinder findJobEvents();
84
85 /***********************************************************************************************************************************************************
86 * Returns a {@link Builder} for adding a {@link Project} to the registry.
87 *
88 * @return the builder
89 **********************************************************************************************************************************************************/
90 @Nonnull
91 public Project.Builder addProject();
92 }