Add ids to offermanager dtos (#310)

* add database id field to builder generated DTOs

* add dedicated constructors to products

* add missing @EqualsAndHashCode annotation

* FacilityFactory searches in label, fullName and enum name

* Bump dependencies

Co-authored-by: Tobias Koch <tobias.koch@qbic.uni-tuebingen.de>
Co-authored-by: Tobias Koch <KochTobi@users.noreply.github.com>

Author: Steffengreiner

pom.xml

@@ -91,7 +91,7 @@
     <dependency>
       <groupId>org.codehaus.groovy</groupId>
       <artifactId>groovy-all</artifactId>
-      <version>3.0.9</version>
+      <version>3.0.10</version>
       <type>pom</type>
       <scope>${osgi.scope}</scope>
     </dependency>
@@ -144,7 +144,7 @@
     <dependency>
       <groupId>org.spockframework</groupId>
       <artifactId>spock-core</artifactId>
-      <version>2.0-groovy-3.0</version>
+      <version>2.1-groovy-3.0</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

src/main/groovy/life/qbic/datamodel/dtos/business/Affiliation.groovy

@@ -11,6 +11,13 @@ import groovy.transform.EqualsAndHashCode
 @EqualsAndHashCode
 final class Affiliation {
 
+  /**
+   * The database id of an affiliation.
+   *
+   * For example "1"
+   */
+  final int id
+
   /**
    * The organisation label of an affiliation.
    *
@@ -61,6 +68,8 @@ final class Affiliation {
 
   static class Builder {
 
+    int id
+
     String organisation
 
     String addressAddition
@@ -78,6 +87,7 @@ final class Affiliation {
     AffiliationLabel label
 
     Builder(String organisation, String street, String postalCode, String city) {
+      this.id = id
       this.organisation = organisation
       this.street = street
       this.postalCode = postalCode
@@ -88,6 +98,11 @@ final class Affiliation {
       this.label = AffiliationLabel.MNF
     }
 
+    Builder id(int id){
+      this.id = id
+      return this
+    }
+
     /**
      * Sets an address addition
      * @param addressAddition
@@ -121,6 +136,7 @@ final class Affiliation {
   }
 
   private Affiliation(Builder builder) {
+    this.id = builder.id
     this.addressAddition = builder.addressAddition
     this.organisation = builder.organisation
     this.street = builder.street

src/main/groovy/life/qbic/datamodel/dtos/business/Offer.groovy

@@ -13,6 +13,12 @@ import life.qbic.datamodel.dtos.projectmanagement.ProjectIdentifier
 @EqualsAndHashCode
 class Offer {
 
+
+    /**
+     * database id of an offer
+     */
+    final int id
+
     /**
      * The checksum of the offer
      */
@@ -111,6 +117,7 @@ class Offer {
 
     static class Builder {
 
+        int id
         /*
         Overall offer describing properties
          */
@@ -189,6 +196,11 @@ class Offer {
             this.projectDescription = Objects.requireNonNull(projectObjective, "Project Objective must not be null")
         }
 
+        Builder id(int id) {
+            this.id = id
+            return this
+        }
+
         Builder checksum(String checksum) {
             this.checksum = checksum
             return this
@@ -280,6 +292,9 @@ class Offer {
     }
 
     private Offer(Builder builder) {
+
+        this.id = builder.id
+
         /*
         Offer Related Properties
          */

src/main/groovy/life/qbic/datamodel/dtos/business/ProductItem.groovy

@@ -13,6 +13,13 @@ import life.qbic.datamodel.dtos.business.services.Product
 @EqualsAndHashCode
 class ProductItem {
 
+    /**
+     * The database of an id of a ProductItem
+     *
+     * For example "1"
+     */
+    final int id
+
     /**
      * Describes the amount of a given item
      */
@@ -55,6 +62,13 @@ class ProductItem {
         this.quantityDiscount = quantityDiscount
     }
 
+    ProductItem(int id, double quantity, Product product, double totalPrice, double quantityDiscount) {
+        this.id = id
+        this.quantity = quantity
+        this.product = product
+        this.totalPrice = totalPrice
+        this.quantityDiscount = quantityDiscount
+    }
 
 
 }

src/main/groovy/life/qbic/datamodel/dtos/business/ProjectApplication.groovy

@@ -1,8 +1,6 @@
 package life.qbic.datamodel.dtos.business
 
-import life.qbic.datamodel.dtos.business.Customer
-import life.qbic.datamodel.dtos.business.OfferId
-import life.qbic.datamodel.dtos.business.ProjectManager
+import groovy.transform.EqualsAndHashCode
 import life.qbic.datamodel.dtos.projectmanagement.ProjectCode
 import life.qbic.datamodel.dtos.projectmanagement.ProjectSpace
 
@@ -19,6 +17,7 @@ import life.qbic.datamodel.dtos.projectmanagement.ProjectSpace
  *
  * @since 2.3.0
  */
+@EqualsAndHashCode
 class ProjectApplication {
 
     /**

src/main/groovy/life/qbic/datamodel/dtos/business/facilities/FacilityFactory.groovy

@@ -21,11 +21,20 @@ class FacilityFactory extends EnumFactory<Facility> {
      */
     @Override
     Facility getForString(String value) {
-        Facility desiredKey
-        desiredKey = Facility.values().find {it.fullName.equals(value.trim())}
-        if (!desiredKey) {
-            throw new IllegalArgumentException("Invalid value '$value' for ${Facility.getSimpleName()}")
-        }
-        return desiredKey
+      Optional<Facility> matchingFullName = Arrays.stream(Facility.values())
+              .filter(it -> it.fullName == value)
+              .findFirst()
+      Optional<Facility> matchingLabel = Arrays.stream(Facility.values())
+              .filter(it -> it.label == value)
+              .findFirst()
+      Optional<Facility> matchingEnumValue = Arrays.stream(Facility.values())
+              .filter(it -> it.name() == value)
+              .findFirst()
+
+      return matchingFullName
+              .orElse( matchingLabel
+                      .orElse(matchingEnumValue
+                              .orElseThrow(() ->
+                                      new IllegalArgumentException("Invalid value '$value' for ${Facility.getSimpleName()}"))))
     }
 }

src/main/groovy/life/qbic/datamodel/dtos/business/services/AtomicProduct.groovy

@@ -50,4 +50,24 @@ class AtomicProduct extends Product {
   AtomicProduct(String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, ProductId productId, Facility serviceProvider) {
     super(name, description, internalUnitPrice, externalUnitPrice, unit, productId, serviceProvider)
   }
+
+  /**
+   * Basic product constructor with id.
+   *
+   * Checks that all passed arguments except id are not null.
+   *
+   * @paran id the id of the product
+   * @param name The name of the product.
+   * @param description The description of what the product is about.
+   * @param internalUnitPrice The price in € per unit for internal customers
+   * @param externalUnitPrice The price in € per unit for external customers
+   * @param unit The product unit
+   * @param productId The product identifier
+   * @param serviceProvider The facility providing the service product
+   *
+   * @since 2.17.0
+   */
+  AtomicProduct(int id, String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, ProductId productId, Facility serviceProvider) {
+    super(id, name, description, internalUnitPrice, externalUnitPrice, unit, productId, serviceProvider)
+  }
 }

src/main/groovy/life/qbic/datamodel/dtos/business/services/DataStorage.groovy

@@ -64,4 +64,25 @@ class DataStorage extends PartialProduct {
   DataStorage(String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, long runningNumber, Facility serviceProvider) {
     super(name, description, internalUnitPrice, externalUnitPrice, unit, new ProductId.Builder(ProductCategory.DATA_STORAGE.getAbbreviation(), runningNumber).build(), serviceProvider)
   }
+
+  /**
+   * Basic product constructor.
+   *
+   * Checks that all passed arguments except id are not null.
+   *
+   * @param id The id of the product.
+   * @param name The name of the product.
+   * @param description The description of what the product is about.
+   * @param internalUnitPrice The price in € per unit for internal customers
+   * @param externalUnitPrice The price in € per unit for external customers
+   * @param unit The product unit
+   * @param runningNumber Number used in conjunction with {@link ProductCategory} to identify product
+   *
+   * @since 2.17.0
+   */
+  DataStorage(int id, String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, long runningNumber, Facility serviceProvider) {
+    super(id, name, description, internalUnitPrice, externalUnitPrice, unit, new ProductId.Builder(ProductCategory.DATA_STORAGE.getAbbreviation(), runningNumber).build(), serviceProvider)
+  }
+
+
 }

src/main/groovy/life/qbic/datamodel/dtos/business/services/ExternalServiceProduct.groovy

@@ -28,4 +28,20 @@ class ExternalServiceProduct extends PartialProduct {
         super(name, description, internalUnitPrice, externalUnitPrice, unit, new ProductId.Builder(
                 ProductCategory.EXTERNAL_SERVICE.getAbbreviation(), runningNumber).build(), serviceProvider)
     }
+
+    /**
+     * Creates an instance of an {@link ExternalServiceProduct}.
+     * @param id the id of the product
+     * @param name The name of the product
+     * @param description A product description
+     * @param internalUnitPrice The net internal unit price of the product
+     * @param externalUnitPrice The net external unit price of the product
+     * @param unit The unit of the product
+     * @param productId A product id, uniquely identifying the product in the offer environment
+     * @param serviceProvider The service provider
+     */
+    ExternalServiceProduct(int id, String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, long runningNumber, Facility serviceProvider) {
+        super(id, name, description, internalUnitPrice, externalUnitPrice, unit, new ProductId.Builder(
+                ProductCategory.EXTERNAL_SERVICE.getAbbreviation(), runningNumber).build(), serviceProvider)
+    }
 }

src/main/groovy/life/qbic/datamodel/dtos/business/services/MetabolomicAnalysis.groovy

@@ -65,5 +65,24 @@ class MetabolomicAnalysis extends AtomicProduct {
   MetabolomicAnalysis(String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, long runningNumber, Facility serviceProvider) {
     super(name, description, internalUnitPrice, externalUnitPrice, unit, new ProductId.Builder(ProductCategory.METABOLOMIC.getAbbreviation(), runningNumber).build(), serviceProvider)
   }
-}
 
+  /**
+   * Basic product constructor with id.
+   *
+   * Checks that all passed arguments except id are not null.
+   *
+   * @paran id the id of the product.
+   * @param name The name of the product.
+   * @param description The description of what the product is about.
+   * @param internalUnitPrice The price in € per unit for internal customers
+   * @param externalUnitPrice The price in € per unit for external customers
+   * @param unit The product unit
+   * @param runningNumber Number used in conjunction with {@link ProductCategory} to identify product
+   * @param serviceProvider The facility providing the service product
+   *
+   * @since 2.17.0
+   */
+  MetabolomicAnalysis(int id, String name, String description, double internalUnitPrice, double externalUnitPrice, ProductUnit unit, long runningNumber, Facility serviceProvider) {
+    super(id, name, description, internalUnitPrice, externalUnitPrice, unit, new ProductId.Builder(ProductCategory.METABOLOMIC.getAbbreviation(), runningNumber).build(), serviceProvider)
+  }
+}