// $HeadURL$
// $Id$
//
// Copyright © 2006, 2010, 2011, 2012 by the President and Fellows of Harvard College.
//
// Screensaver is an open-source project developed by the ICCB-L and NSRB labs
// at Harvard Medical School. This software is distributed under the terms of
// the GNU General Public License.

package edu.harvard.med.screensaver.model.cherrypicks;

import javax.persistence.Entity;
import javax.persistence.PrimaryKeyJoinColumn;
import javax.persistence.Transient;

import org.joda.time.LocalDate;

import edu.harvard.med.screensaver.model.AbstractEntityVisitor;
import edu.harvard.med.screensaver.model.Volume;
import edu.harvard.med.screensaver.model.VolumeUnit;
import edu.harvard.med.screensaver.model.libraries.PlateType;
import edu.harvard.med.screensaver.model.screens.Screen;
import edu.harvard.med.screensaver.model.users.AdministratorUser;
import edu.harvard.med.screensaver.model.users.ScreeningRoomUser;

/**
 * A hibernate entity representing a small molecule cherry pick request.
 *
 * @author <a mailto="john_sullivan@hms.harvard.edu">John Sullivan</a>
 * @author <a mailto="andrew_tolopko@hms.harvard.edu">Andrew Tolopko</a>
 */
@Entity
@PrimaryKeyJoinColumn(name="cherryPickRequestId")
@org.hibernate.annotations.ForeignKey(name="fk_small_molecule_cherry_pick_request_to_cherry_pick_request")
@org.hibernate.annotations.Proxy
public class SmallMoleculeCherryPickRequest extends CherryPickRequest
{
  private static final long serialVersionUID = 1L;
  private static final PlateType SMALL_MOLECULE_CHERRY_PICK_ASSAY_PLATE_TYPE = PlateType.ABGENE;
  private static final Volume DEFAULT_TRANSFER_VOLUME = new Volume("1.20", VolumeUnit.MICROLITERS);

  /**
   * Construct an uninitialized <code>SmallMoleculeCherryPickRequest</code>.
   * 
   * @motivation for hibernate and proxy/concrete subclass constructors
   */
  protected SmallMoleculeCherryPickRequest()
  {}

  /**
   * Construct an initialized <code>SmallMoleculeCherryPickRequest</code>.
   * 
   * @motivation Intended only for use by {@link Screen}.
   */
  public SmallMoleculeCherryPickRequest(
    AdministratorUser createdBy,
    Screen screen,
    ScreeningRoomUser requestedBy,
    LocalDate dateRequested)
  {
    super(createdBy, screen, requestedBy, dateRequested);
  }

  @Override
  public Object acceptVisitor(AbstractEntityVisitor visitor)
  {
    return visitor.visit(this);
  }

  @Override
  @Transient
  public PlateType getDefaultAssayPlateType()
  {
    return SMALL_MOLECULE_CHERRY_PICK_ASSAY_PLATE_TYPE;
  }

  @Override
  @Transient
  public Volume getDefaultTransferVolume()
  {
    return DEFAULT_TRANSFER_VOLUME;
  }
}