Add Primary Storage as a StorageItemType (#44)

Author: labkey-susanh

labkey-client-api/CHANGELOG.md

@@ -1,9 +1,10 @@
 # The LabKey Remote API Library for Java - Change Log
 
-## version 4.1.0-SNAPSHOT
-*Released*: TBD
+## version 4.1.0
+*Released*: 15 December 2022
 * Migrate internal HTTP handling to use Apache HttpClient 5.2
 * Generate and execute path-first URLs
+* Add PrimaryStorage a new StorageItemTypes for non-freezer storage
 
 ## version 4.0.0
 *Released*: 26 October 2022

labkey-client-api/build.gradle

@@ -48,7 +48,7 @@ repositories {
 
 group "org.labkey.api"
 
-version "4.1.0-SNAPSHOT"
+version "4.2.0-SNAPSHOT"
 
 dependencies {
     api "org.json:json:${jsonObjectVersion}"

labkey-client-api/src/org/labkey/remoteapi/storage/CreateCommand.java

@@ -1,29 +1,31 @@
 package org.labkey.remoteapi.storage;
 
 /**
- * Create a new LabKey Freezer Manager storage item that can be used in the creation of a freezer hierarchy.
- * Freezer hierarchies consist of a top level Freezer, which can have any combination of child non-terminal storage
- * locations (i.e. those that do not directly contain samples but can contain other units) and terminal storage
- * locations (i.e. units in the freezer that directly contain samples and cannot contain other units).
+ * Create a new LabKey Freezer Manager storage item that can be used in the creation of a storage hierarchy.
+ * Storage hierarchies consist of a top level Freezer or Primary Storage, which can have any combination of
+ * child non-terminal storage locations (i.e., those that do not directly contain samples but can contain other
+ * units) and terminal storage locations (i.e., units in the storage location that directly contain samples and cannot contain
+ * other units).
  * See the <a href="https://www.labkey.org/SampleManagerHelp/wiki-page.view?name=createFreezer">LabKey Documentation</a>
  * for further details.
  * <p>
- * A freezer may also have a parent hierarchy, which defines the physical location of the freezer.
+ * A storage location may also have a parent hierarchy, which defines the physical location of the storage location.
  * See the <a href="https://www.labkey.org/SampleManagerHelp/wiki-page.view?name=freezerLocation">LabKey Documentation</a>
  * for further details.
  * <p>
- * Storage items can be of the following types: Physical Location, Freezer, Shelf, Rack, Canister,
+ * Storage items can be of the following types: Physical Location, Freezer, Primary Storage, Shelf, Rack, Canister,
  * Storage Unit Type, or Terminal Storage Location. One of these values must be set as the "type" for
  * the {@link StorageRow} provided to the CreateCommand constructor.
  * <p>
  * The additional properties for the storage item being created can be provided as the "props" for the
  * {@link StorageRow}. The specific set of props will differ for each storage item type:
  * <ul>
  *     <li>Physical Location: name, description, locationId (rowId of the parent Physical Location)</li>
- *     <li>Freezer: name, description, locationId (rowId of the parent Physical Location), manufacturer, freezerModel, temperature, temperatureUnits, serialNumber, sensorName, lossRate, status</li>
- *     <li>Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer or Shelf/Rack/Canister)</li>
+ *     <li>Freezer: name, description, locationId (rowId of the parent Physical Location), manufacturer, freezerModel, temperature, temperatureUnits, serialNumber, sensorName, lossRate, status, temperatureControlled (boolean)</li>
+ *     <li>Primary Storage: name, description, locationId (rowId of the parent Physical Location), temperatureControlled (boolean)</li>
+ *     <li>Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer, primary storage, or Shelf/Rack/Canister)</li>
  *     <li>Storage Unit Type: name, description, unitType (one of the following: "Box", "Plate", "Bag", "Cane", "Tube Rack"), rows, cols (required if positionFormat is not "Num"), positionFormat (one of the following: "Num", "AlphaNum", "AlphaAlpha", "NumAlpha", "NumNum"), positionOrder (one of the following: "RowColumn", "ColumnRow")</li>
- *     <li>Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer or Shelf/Rack/Canister)</li>
+ *     <li>Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer, primary storage or Shelf/Rack/Canister)</li>
  * </ul>
  * <p>
  * Examples:

labkey-client-api/src/org/labkey/remoteapi/storage/StorageItemTypes.java

@@ -19,6 +19,7 @@ public enum StorageItemTypes
 {
     PhysicalLocation("Physical Location"),
     Freezer("Freezer"),
+    PrimaryStorage("Primary Storage"),
     Shelf("Shelf"),
     Rack("Rack"),
     Canister("Canister"),