Invoice.java

  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. import javax.annotation.Nonnull;
  28. import javax.annotation.concurrent.Immutable;
  29. import java.time.LocalDate;
  30. import java.util.List;
  31. import it.tidalwave.accounting.model.spi.ObjectFactory;
  32. import it.tidalwave.accounting.model.types.Money;
  33. import it.tidalwave.util.As;
  34. import it.tidalwave.util.Finder;
  35. import it.tidalwave.util.Id;
  36. import it.tidalwave.role.Identifiable;
  37. import lombok.AllArgsConstructor;
  38. import lombok.Getter;
  39. import lombok.ToString;
  40. import lombok.With;

  41. /***************************************************************************************************************************************************************
  42.  *
  43.  * @author  Fabrizio Giudici
  44.  *
  45.  **************************************************************************************************************************************************************/
  46. @Immutable
  47. public interface Invoice extends Identifiable, As
  48.   {
  49.     /***********************************************************************************************************************************************************
  50.      *
  51.      **********************************************************************************************************************************************************/
  52.     @AllArgsConstructor// FIXME (access = PRIVATE)
  53.     @Immutable @With @Getter @ToString
  54.     public static class Builder
  55.       {
  56.         public static interface Callback // Lombok @With doesn't support builder subclasses
  57.           {
  58.             public void register (@Nonnull final Invoice invoice);

  59.             public static final Callback DEFAULT = (invoice) -> {};
  60.           }

  61.         private final Id id;
  62.         private final String number;
  63.         private final Project project;
  64.         private final List<? extends JobEvent> jobEvents; // FIXME: immutablelist
  65.         private final LocalDate date;
  66.         private final LocalDate dueDate;
  67.         private final Money earnings;
  68.         private final Money tax;
  69.         private final Callback callback;

  70.         public Builder()
  71.           {
  72.             this(Callback.DEFAULT);
  73.           }

  74.         public Builder (@Nonnull final Callback callback)
  75.           {
  76.             this(new Id(""), "", null, null, null, null, Money.ZERO, Money.ZERO, callback);
  77.           }

  78.         @Nonnull
  79.         public Builder with (@Nonnull final Builder builder)
  80.           {
  81.             return builder.withCallback(callback);
  82.           }

  83.         @Nonnull
  84.         public Invoice create()
  85.           {
  86.               // TODO
  87. //            if (!jobEvents.stream().allMatch(jobEvent -> jobEvent.getProject() == project))
  88. //              {
  89. //                // FIXME: better diagnostics
  90. //                throw new IllegalArgumentException("Illegal project for jobEvent");
  91. //              }

  92.             final var invoice = ObjectFactory.getInstance().createInvoice(this);
  93.             callback.register(invoice);
  94.             return invoice;
  95.           }
  96.       }

  97.     /***********************************************************************************************************************************************************
  98.      * Creates a finder for job events.
  99.      *
  100.      * @return    the finder
  101.      **********************************************************************************************************************************************************/
  102.     @Nonnull
  103.     public Finder<JobEvent> findJobEvents();

  104.     /***********************************************************************************************************************************************************
  105.      * Returns a builder pre-populated with all the attributes.
  106.      *
  107.      * @return  the builder
  108.      **********************************************************************************************************************************************************/
  109.     @Nonnull
  110.     public Builder toBuilder();
  111.   }