Package org.labkey.remoteapi.storage

Class StorageRow

java.lang.Object
org.labkey.remoteapi.storage.StorageRow
public class StorageRow extends Object
The storage properties object used for the storage CreateCommand, UpdateCommand, and DeleteCommand. This object will define the type of the item along with the specific properties for that storage item.

  • Constructor Details

    • StorageRow

      public StorageRow()

  • Method Details

    • getType

      public String getType()

    • setType

      public void setType(StorageItemTypes type)
      Storage items can be of the following types: Physical Location, Freezer, Shelf, Rack, Canister, Storage Unit Type, or Terminal Storage Location. One of these values must be set as the "type" for the StorageRow provided to the CreateCommand, UpdateCommand, or DeleteCommand constructor.
      Parameters:
      type - Type value for the given storage item/row

    • getProps

      public Map<String,Object> getProps()

    • setProps

      public void setProps(Map<String,Object> props)
      The additional properties for the storage item being created/updated can be provided as the "props" for the StorageRow. The specific set of props will differ for each storage item type:
      • Physical Location: name, description, locationId (rowId of the parent Physical Location)
      • Freezer: name, description, locationId (rowId of the parent Physical Location), manufacturer, freezerModel, temperature, temperatureUnits, serialNumber, sensorName, lossRate, status
      • Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer or Shelf/Rack/Canister)
      • 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")
      • Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer or Shelf/Rack/Canister)
      Parameters:
      props - Map of properties for the given storage item/row

    • setRowId

      public void setRowId(Integer rowId)
      For the UpdateCommand and DeleteCommand, the "rowId" primary key value is required to be set. This helper method will put the rowId value into the "props" for this StorageRow.
      Parameters:
      rowId - Integer rowId primary key for the given storage item/row

    • toJsonObject

      public org.json.JSONObject toJsonObject()