Class Kit

    • Constructor Detail

      • Kit

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

      • 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.
        Parameters:
        itemType - The item type
        Returns:
        The system id of the default kit type or null
      • getNew

        public static Kit getNew​(DbControl dc)
                          throws BaseException
        Create a new Kit item.
        Parameters:
        dc - The DbControl which will be used for permission checking and database access.
        Returns:
        The new Kit item
        Throws:
        BaseException - This exception is thrown if there is another error
      • 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
        Returns:
        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
        Returns:
        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
        Parameters:
        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
        Returns:
        Always null
      • 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.
        Parameters:
        inactive - TRUE if the kit is inactive, FALSE otherwise.
        Throws:
        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.
        Parameters:
        expirationDate - A date or null
        Throws:
        PermissionDeniedException - If the logged in user doesn't have write permission on the item.