Package: JobEvent

JobEvent

name	instruction	branch	complexity	line	method
builder()	M: 0 C: 4 100%	M: 0 C: 0 100%	M: 0 C: 1 100%	M: 0 C: 1 100%	M: 0 C: 1 100%

Coverage

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 javax.annotation.concurrent.Immutable;
30: import java.time.LocalDateTime;
31: import java.util.Collections;
32: import java.util.List;
33: import it.tidalwave.accounting.model.spi.ObjectFactory;
34: import it.tidalwave.accounting.model.types.Money;
35: import it.tidalwave.util.As;
36: import it.tidalwave.util.Id;
37: import it.tidalwave.role.Identifiable;
38: import lombok.AllArgsConstructor;
39: import lombok.Getter;
40: import lombok.ToString;
41: import lombok.With;
42:
43: /***************************************************************************************************************************************************************
44: *
45: * This class models a single job event.
46: *
47: * @author Fabrizio Giudici
48: *
49: **************************************************************************************************************************************************************/
50: @Immutable
51: public interface JobEvent extends Identifiable, As
52: {
53: public enum Type { TIMED, FLAT }
54:
55: /***********************************************************************************************************************************************************
56: *
57: **********************************************************************************************************************************************************/
58: @AllArgsConstructor// FIXME (access = PROTECTED)
59: @Immutable @With @Getter @ToString
60: public static class Builder
61: {
62: private final Id id;
63: private final Type type;
64: private final LocalDateTime startDateTime;
65: private final LocalDateTime endDateTime;
66: private final String name;
67: private final String description;
68: private final Money earnings;
69: private final Money hourlyRate;
70: private final List<? extends JobEvent> events; // FIXME: immutable
71:
72: public Builder()
73: {
74: this(new Id(""), Type.TIMED, null, null, "", "", Money.ZERO, Money.ZERO, Collections.emptyList());
75: }
76:
77: @Nonnull
78: public JobEvent create()
79: {
80: return ObjectFactory.getInstance().createJobEvent(this);
81: }
82: }
83:
84: /***********************************************************************************************************************************************************
85: * Creates a builder for a job event.
86: *
87: * @return the builder
88: **********************************************************************************************************************************************************/
89: @Nonnull
90: public static JobEvent.Builder builder()
91: {
92: return new JobEvent.Builder(); // FIXME: avoid nulls
93: }
94:
95: /***********************************************************************************************************************************************************
96: * Returns a builder pre-populated with all the attributes.
97: *
98: * @return the builder
99: **********************************************************************************************************************************************************/
100: @Nonnull
101: public JobEvent.Builder toBuilder();
102: }