/*
 * Copyright (c) 2012. The Genome Analysis Centre, Norwich, UK
 * MISO project contacts: Robert Davey, Mario Caccamo @ TGAC
 * *********************************************************************
 *
 * This file is part of MISO.
 *
 * MISO is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MISO is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MISO.  If not, see <http://www.gnu.org/licenses/>.
 *
 * *********************************************************************
 */

package uk.ac.bbsrc.tgac.miso.core.store;

import uk.ac.bbsrc.tgac.miso.core.data.RunQC;
import uk.ac.bbsrc.tgac.miso.core.data.SampleQC;
import uk.ac.bbsrc.tgac.miso.core.data.type.QcType;

import java.io.IOException;
import java.util.Collection;

/**
 * Defines a DAO interface for storing RunQCs
 *
 * @author Rob Davey
 * @since 0.0.3
 */
public interface RunQcStore extends Store<RunQC>, Remover<RunQC> {
  /**
   * Retrieve a RunQC from an underlying data store given a RunQC ID
   * <p/>
   * This method intends to retrieve objects in an 'ignorant' fashion, i.e.  will not populate
   * parent or child objects that could lead to a circular dependency
   *
   * @param qcId of type long
   * @return RunQC
   * @throws java.io.IOException when
   */
  //RunQC lazyGet(long qcId) throws IOException;

  /**
   * List all RunQCs performed on a Run given a parent Run ID
   *
   * @param runId of type long
   * @return Collection<RunQC>
   * @throws java.io.IOException when
   */
  Collection<RunQC> listByRunId(long runId) throws IOException;

  /**
   * Get the QcType descriptor for a given type ID
   * @param qcTypeId
   * @return the QcType with the given ID, or null if none exists
   * @throws IOException
   */
  QcType getRunQcTypeById(long qcTypeId) throws IOException;

  /**
   * Get the QcType descriptor for a given type name
   * @param qcName
   * @return the QcType with the given name, or null if none exists
   * @throws IOException
   */
  QcType getRunQcTypeByName(String qcName) throws IOException;

  /**
   * Get all QcType descriptors for {@link uk.ac.bbsrc.tgac.miso.core.data.Run} objects
   * @return Collection<QcType>
   * @throws IOException
   */
  Collection<QcType> listAllRunQcTypes() throws IOException;
}