Class Kit

All Implemented Interfaces:
AccessControlled, Annotatable, Identifiable, Nameable, Ownable, Registered, Removable, Shareable, Subtypable

public class Kit
extends AnnotatedItem
implements Registered, Subtypable
This class is used to represent a kit of reagents and other stuff used in the lab process.
  • Field Details

  • Constructor Details

    • Kit

      Kit​(KitData data)
      Creates a new kit item.
      data - the data
  • Method Details

    • getDefaultSystemId

      public static String getDefaultSystemId​(Item itemType)
      Get the system id for the kit subtype that should be used on an item that doesn't have a subtype. This includes Subtypable items with a null ItemSubtype and all other non-subtypable items which can be linked to a kit.
      itemType - The item type
      The system id of the default kit type or null
    • getNew

      public static Kit getNew​(DbControl dc) throws BaseException
      Create a new Kit item.
      dc - The DbControl which will be used for permission checking and database access.
      The new Kit item
      BaseException - This exception is thrown if there is another error
    • getById

      public static Kit getById​(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
      Get a Kit item when you know the ID.
      dc - The DbControl which will be used for permission checking and database access.
      id - The ID of the item to load
      The Kit item
      ItemNotFoundException - If an item with the specified ID is not found
      PermissionDeniedException - If the logged in user doesn't have Permission.READ permission to the item
      BaseException - If there is another error
    • getQuery

      public static ItemQuery<Kit> getQuery() throws BaseException
      Get a query configured to retrieve kits.
      An ItemQuery object
      BaseException - If getting the query fails.
    • getData

      KitData getData()
      Description copied from class: BasicItem
      Get the BasicData object that holds all data for this item.
      getData in class AnnotatedItem
    • getType

      public Item getType()
      Description copied from interface: Identifiable
      Get the type of item represented by the object. The returned value is one of the values defined in the Item enumeration.
      Specified by:
      getType in interface Identifiable
      A value indicating the type of item
    • getEntryDate

      public Date getEntryDate()
      Description copied from interface: Registered
      Get the date that the item was registered in the database.
      Specified by:
      getEntryDate in interface Registered
      A date or null if this is not known
    • setEntryDate

      public void setEntryDate​(Date entryDate)
      Description copied from interface: Registered
      Set the date the entry was registered in the database. Implementations should only allow this property to be set before the item is first stored in the database. The intention of this method is to facilitate export/import of data between server.
      Specified by:
      setEntryDate in interface Registered
      entryDate - A date or null to use today's date
    • getAnnotatableParents

      public Set<Annotatable> getAnnotatableParents()
      Description copied from interface: Annotatable
      Get all parents objects which are annotatable and the logged in user has read permission to. If the item doesn't have any annotatable parents, it may return null or an empty set. The method should only return the immediate parent(s), not parents to parents, etc. As of BASE 3.1 this method may also return child items if the child item is a Subtypable item that has a subtype with the ItemSubtype.getPushAnnotations() flag set.
      Specified by:
      getAnnotatableParents in interface Annotatable
      Always null
    • getItemSubtype

      public ItemSubtype getItemSubtype()
      Description copied from interface: Subtypable
      Get the subtype of the item.
      Specified by:
      getItemSubtype in interface Subtypable
      A subtype of null if not set
      See Also:
    • setItemSubtype

      public void setItemSubtype​(ItemSubtype subtype)
      Description copied from interface: Subtypable
      Set the subtype on the item.
      Specified by:
      setItemSubtype in interface Subtypable
      subtype - A subtype or null
      See Also:
    • isUsed

      public boolean isUsed() throws BaseException
      Check if:
      isUsed in class BasicItem
      TRUE if this item is used, FALSE otherwise
      BaseException - If not able to tell if item is used or not.
      See Also:
    • getUsingItems

      public Set<ItemProxy> getUsingItems()
      Get all:
      getUsingItems in class BasicItem
      A set containing proxies for the items, or an empty set if no items are using this item
      See Also:
      BasicItem.addUsingItems(Set, Item, org.hibernate.query.Query)
    • isInactive

      public boolean isInactive()
      Check if the kit is inactive. An inactive kit should not be used when creating new biomaterial. This is a recommendation only and is not enforced by the core API.
    • setInactive

      public void setInactive​(boolean inactive) throws PermissionDeniedException
      Set the inactive flag.
      inactive - TRUE if the kit is inactive, FALSE otherwise.
      PermissionDeniedException - If the logged in user doesn't have write permission on the item.
    • getExpirationDate

      public Date getExpirationDate()
      Get the expiration date of the kit. A kit should not be used after it's expiration date. This is a recommendation only and is not enforced by the core API.
    • setExpirationDate

      public void setExpirationDate​(Date expirationDate)
      Set the expiration date.
      expirationDate - A date or null
      PermissionDeniedException - If the logged in user doesn't have write permission on the item.