ReleaseDao.java

/**
 * Copyright (C) 2013 Johannes Schnatterer
 *
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This file is part of nusic.
 *
 * nusic 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.
 *
 * nusic 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 nusic.  If not, see <http://www.gnu.org/licenses/>.
 */
package info.schnatterer.nusic.data.dao;

import info.schnatterer.nusic.data.DatabaseException;
import info.schnatterer.nusic.data.model.Release;

import java.util.List;

public interface ReleaseDao extends GenericDao<Release> {

    /**
     * Finds out of if release with a specific
     * {@link Release#getMusicBrainzId()} exists.
     * 
     * @param musicBrainzId
     * @return the {@link Release} containing ID and dateCreated, if existing
     *         Otherwise <code>null</code>.
     * @throws DatabaseException
     */
    Release findByMusicBrainzId(String musicBrainzId) throws DatabaseException;

    /**
     * Finds all releases that were created after a specific date and are not
     * hidden. Order by release date descending.
     * 
     * @param gtDateCreated
     *            all releases whose creation data is greater than this date are
     *            returned.
     * 
     * @return all releases that were created after <code>gtDateCreated</code>
     * @throws DatabaseException
     */
    List<Release> findByDateCreatedGreaterThanAndIsHiddenNotTrue(
            long gtDateCreated) throws DatabaseException;

    /**
     * Finds all releases whose release date is greater than or equal to a
     * specific date and are not hidden. Order by release date ascending.
     * 
     * @param gtEqReleaseDate
     *            all releases whose release date greater than or equal to this
     *            date are returned
     * @return all releases whose release date is at or after
     *         <code>gtEqReleaseDate</code>
     * @throws DatabaseException
     */
    List<Release> findByReleaseDateGreaterThanEqualsAndIsHiddenNotTrueSortByReleaseDateAsc(
            long gtEqReleaseDate) throws DatabaseException;

    /**
     * Finds all releases whose release date is greater than or equal to a
     * specific date and are not hidden. Order by release date descending.
     * 
     * @param gtEqReleaseDate
     *            all releases whose release date greater than or equal to this
     *            date are returned
     * @return all releases whose release date is at or after
     *         <code>gtEqReleaseDate</code>
     * @throws DatabaseException
     */
    List<Release> findByReleaseDateGreaterThanEqualsAndIsHiddenNotTrueSortByReleaseDateDesc(
            long gtEqReleaseDate) throws DatabaseException;

    /**
     * Finds all releases whose release date is within a specific range and are
     * not hidden. Order by release date descending.
     * 
     * @param gtEqReleaseDate
     *            all releases whose release date greater than or equal to this
     *            date are returned
     * @param ltReleaseDate
     *            all releases whose release date is less than this date are
     *            returned
     * @return all releases whose release date is at or after
     *         <code>gtEqReleaseDate</code> and before
     *         <code>ltReleaseDate</code>
     * @throws DatabaseException
     */
    List<Release> findByReleaseDateGreaterThanEqualsAndReleaseDateLessThanAndIsHiddenNotTrue(
            long gtEqReleaseDate, long ltRealaseDate) throws DatabaseException;

    /**
     * Set <code>isHidden</code> to <code>false</code> for all {@link Release}s.
     */
    void setIsHiddenFalse() throws DatabaseException;
}