src/main/java/de/uapcore/lightpit/dao/IssueDao.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2018 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */
package de.uapcore.lightpit.dao;

import de.uapcore.lightpit.entities.Issue;
import de.uapcore.lightpit.entities.Project;
import de.uapcore.lightpit.entities.Version;

import java.sql.SQLException;
import java.util.List;

public interface IssueDao extends GenericDao<Issue> {

    /**
     * Lists all issues for the specified project.
     * This is not guaranteed to contain version information.
     * Use {@link #joinVersionInformation(Issue)} to obtain this information for a specific issue.
     *
     * @param project the project
     * @return a list of issues
     * @throws SQLException on any kind of SQL error
     */
    List<Issue> list(Project project) throws SQLException;

    /**
     * Lists all issues that are somehow related to the specified version.
     * If version is null, search for issues that are not related to any version.
     *
     * @param version the version or null
     * @return a list of issues
     * @throws SQLException on any kind of SQL error
     */
    List<Issue> list(Version version) throws SQLException;

    /**
     * Saves an instances to the database.
     * Implementations of this DAO must guarantee that the generated ID is stored in the instance.
     *
     * @param instance the instance to insert
     * @throws SQLException on any kind of SQL error
     * @see Issue#setId(int)
     */
    @Override
    void save(Issue instance) throws SQLException;

    /**
     * Retrieves the affected, scheduled and resolved versions for the specified issue.
     *
     * @param issue the issue to join the information for
     * @throws SQLException on any kind of SQL error
     */
    void joinVersionInformation(Issue issue) throws SQLException;
}