LightPIT: src/main/java/de/uapcore/lightpit/dao/IssueDao.java@0a658e53177c

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  *

     4  * Copyright 2018 Mike Becker. All rights reserved.

     5  *

     6  * Redistribution and use in source and binary forms, with or without

     7  * modification, are permitted provided that the following conditions are met:

     8  *

     9  *   1. Redistributions of source code must retain the above copyright

    10  *      notice, this list of conditions and the following disclaimer.

    11  *

    12  *   2. Redistributions in binary form must reproduce the above copyright

    13  *      notice, this list of conditions and the following disclaimer in the

    14  *      documentation and/or other materials provided with the distribution.

    15  *

    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

    26  * POSSIBILITY OF SUCH DAMAGE.

    27  *

    28  */

    29 package de.uapcore.lightpit.dao;

    31 import de.uapcore.lightpit.entities.Issue;

    32 import de.uapcore.lightpit.entities.Project;

    33 import de.uapcore.lightpit.entities.Version;

    35 import java.sql.SQLException;

    36 import java.util.List;

    38 public interface IssueDao extends GenericDao<Issue> {

    40     /**

    41      * Lists all issues for the specified project.

    42      * This is not guaranteed to contain version information.

    43      * Use {@link #joinVersionInformation(Issue)} to obtain this information for a specific issue.

    44      *

    45      * @param project the project

    46      * @return a list of issues

    47      * @throws SQLException on any kind of SQL error

    48      */

    49     List<Issue> list(Project project) throws SQLException;

    51     /**

    52      * Lists all issues that are somehow related to the specified version.

    53      *

    54      * @param version the version

    55      * @return a list of issues

    56      * @throws SQLException on any kind of SQL error

    57      */

    58     List<Issue> list(Version version) throws SQLException;

    60     /**

    61      * Saves an instances to the database.

    62      * Implementations of this DAO must guarantee that the generated ID is stored in the instance.

    63      *

    64      * @param instance the instance to insert

    65      * @throws SQLException on any kind of SQL error

    66      * @see Issue#setId(int)

    67      */

    68     @Override

    69     void save(Issue instance) throws SQLException;

    71     /**

    72      * Retrieves the affected, scheduled and resolved versions for the specified issue.

    73      *

    74      * @param issue the issue to join the information for

    75      * @throws SQLException on any kind of SQL error

    76      */

    77     void joinVersionInformation(Issue issue) throws SQLException;

    78 }

Mercurial > hg > LightPIT / file revision