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.LocalDateTime;
31 import it.tidalwave.accounting.model.JobEvent;
32 import it.tidalwave.accounting.model.types.Money;
33
34 /***************************************************************************************************************************************************************
35 *
36 * @author Fabrizio Giudici
37 *
38 **************************************************************************************************************************************************************/
39 public interface JobEventSpi extends JobEvent
40 {
41 /***********************************************************************************************************************************************************
42 * Returns the name of this event.
43 *
44 * @return the name
45 **********************************************************************************************************************************************************/
46 @Nonnull
47 public String getName();
48
49 /***********************************************************************************************************************************************************
50 * Returns the description of this event.
51 *
52 * @return the description
53 **********************************************************************************************************************************************************/
54 @Nonnull
55 public String getDescription();
56
57 /***********************************************************************************************************************************************************
58 * Returns the duration of this event.
59 *
60 * @return the duration
61 **********************************************************************************************************************************************************/
62 @Nonnull
63 public Duration getDuration();
64
65 /***********************************************************************************************************************************************************
66 * Returns the earnings of this event.
67 *
68 * @return the earnings
69 **********************************************************************************************************************************************************/
70 @Nonnull
71 public Money getEarnings();
72
73 /***********************************************************************************************************************************************************
74 * Returns the datetime of this event.
75 *
76 * @return the datetime
77 **********************************************************************************************************************************************************/
78 @Nonnull
79 public LocalDateTime getDateTime();
80 }