Changeset 6990

Timestamp:

Nov 2, 2015, 9:13:34 AM (8 years ago)

Author:

Nicklas Nordborg

Message:

References #1958: Add Kit item

Added Kit item in the core layer and links to it from the BioMaterialEvent and BioPlateEvent classes.

Added TestKit for testing the kit item.

Location:

trunk/src

Files:

• core/common-queries.xml (modified) (1 diff)
• core/net/sf/basedb/core/BioMaterialEvent.java (modified) (1 diff)
• core/net/sf/basedb/core/BioPlateEvent.java (modified) (2 diffs)
• core/net/sf/basedb/core/Install.java (modified) (1 diff)
• core/net/sf/basedb/core/Item.java (modified) (1 diff)
• core/net/sf/basedb/core/Kit.java (added)
• test/TestAll.java (modified) (1 diff)
• test/TestKit.java (added)

trunk/src/core/common-queries.xml

@@ -876 +876 @@
       A Hibernate query that gets raw bioassays
       using a protocol.
+    </description>
+  </query>
+
+  <query id="GET_BIOMATERIALEVENTS_FOR_KIT" type="HQL">
+    <sql>
+      SELECT {1}
+      FROM BioMaterialEventData bme
+      WHERE bme.kit = :kit
+    </sql>
+    <description>
+      A Hibernate query that gets biomaterial
+      events using a kit.
+    </description>
+  </query>
+
+  <query id="GET_BIOPLATEEVENTS_FOR_KIT" type="HQL">
+    <sql>
+      SELECT {1}
+      FROM BioPlateEventData bpe
+      WHERE bpe.kit = :kit
+    </sql>
+    <description>
+      A Hibernate query that gets bioplate events
+      events using a kit.
     </description>
   </query>

trunk/src/core/net/sf/basedb/core/BioMaterialEvent.java

@@ -568 +568 @@
     hardwareHasBeenSet = true;
     getData().setHardware(hardware == null ? null : hardware.getData());
+  }
+
+  /**
+    Get the {@link Kit} that was used in this event.
+    @return A <code>Kit</code> item, or null if not known
+    @throws PermissionDeniedException If the logged in user doesn't have
+      read permission to the kit
+    @throws BaseException If there is another error
+    @since 3.7
+  */
+  public Kit getKit()
+    throws PermissionDeniedException, BaseException
+  {
+    return getDbControl().getItem(Kit.class, getData().getKit());
+  }
+  
+  /**
+    Set the {@link Kit} that was used in this event.
+    @param kit A <code>Kit</code> item, or null if not known
+    @throws PermissionDeniedException If the logged in user doesn't have
+      write permission on this event or use permission for the kit
+    @since 3.7
+  */
+  public void setKit(Kit kit)
+    throws PermissionDeniedException
+  {
+    checkPermission(Permission.WRITE);
+    if (kit != null) kit.checkPermission(Permission.USE);
+    getData().setKit(kit == null ? null : kit.getData());
   }
 

trunk/src/core/net/sf/basedb/core/BioPlateEvent.java

@@ -249 +249 @@
 
   /**
+    Get the {@link Kit} that was used in this event.
+    @return A <code>Kit</code> item, or null if not known
+    @throws PermissionDeniedException If the logged in user doesn't have
+      read permission to the kit
+    @throws BaseException If there is another error
+    @since 3.7
+  */
+  public Kit getKit()
+    throws PermissionDeniedException, BaseException
+  {
+    return getDbControl().getItem(Kit.class, getData().getKit());
+  }
+  
+  /**
+    Set the {@link Kit} that was used in this event. The kit
+    is also updated on all related biomaterial events (when the
+    transaction is committed).
+    
+    @param kit A <code>Kit</code> item, or null if not known
+    @throws PermissionDeniedException If the logged in user doesn't have
+      write permission on this event or use permission for the kit
+    @since 3.7
+  */
+  public void setKit(Kit kit)
+    throws PermissionDeniedException
+  {
+    checkPermission(Permission.WRITE);
+    if (kit != null) kit.checkPermission(Permission.USE);
+    getData().setKit(kit == null ? null : kit.getData());
+    needSynchronize = true;
+  }
+  
+
+  /**
     Get the date this event was done in the lab.
     @return A <code>Date</code> object, or null if not known
@@ -447 +481 @@
     event.setProtocol(data.getProtocol());
     event.setHardware(data.getHardware());
+    event.setKit(data.getKit());
   }
   

trunk/src/core/net/sf/basedb/core/Install.java

@@ -338 +338 @@
       createRoleKey(Item.HARDWARE, "Hardware", "Gives access to hardware", power_users_create);
       createRoleKey(Item.SOFTWARE, "Software", "Gives access to software", power_users_create);
-      
+      createRoleKey(Item.KIT, "Kit", "Gives access to kits", power_users_create);
+
       // Platforms, platform variants, platform file types
       createRoleKey(Item.PLATFORM, "Platforms", "Gives access to platforms", guests_use_administrators_all);

trunk/src/core/net/sf/basedb/core/Item.java

@@ -202 +202 @@
     720),
 
+  /**
+    The item is a {@link Kit}.
+    @since 3.7
+  */
+  KIT(125, "Kit", "kt", Kit.class, KitData.class, DefinedPermissions.shareable,
+    730),
+
+  
   /**
     The item is a {@link News}.

trunk/src/test/TestAll.java

@@ -71 +71 @@
     results.put("TestSoftware", TestSoftware.test_all());
     results.put("TestProtocol", TestProtocol.test_all());
+    results.put("TestKit", TestKit.test_all());
 
     // File parsing