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

     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.*;

    33 import java.sql.SQLException;

    34 import java.util.List;

    36 public interface IssueDao extends ChildEntityDao<Issue, Project> {

    38     /**

    39      * Lists all issues that are related to the specified component and version.

    40      * If component or version is null, search for issues that are not assigned to any

    41      * component or version, respectively.

    42      *

    43      * @param project the project

    44      * @param component the component or null

    45      * @param version the version or null

    46      * @return a list of issues

    47      * @throws SQLException on any kind of SQL error

    48      */

    49     List<Issue> list(Project project, Component component, Version version) throws SQLException;

    51     /**

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

    53      * If the version is null, lists issues that are not assigned to any version.

    54      *

    55      * @param project the project (mandatory)

    56      * @param version the version or null

    57      * @return a list of issues

    58      * @throws SQLException on any kind of SQL error

    59      */

    60     List<Issue> list(Project project, Version version) throws SQLException;

    62     /**

    63      * Lists all issues that are related to the specified component.

    64      * If the component is null, lists issues that are not assigned to a component.

    65      *

    66      * @param project the project (mandatory)

    67      * @param component the component or null

    68      * @return a list of issues

    69      * @throws SQLException on any kind of SQL error

    70      */

    71     List<Issue> list(Project project, Component component) throws SQLException;

    73     /**

    74      * Lists all comments for a specific issue in chronological order.

    75      *

    76      * @param issue the issue

    77      * @return the list of comments

    78      * @throws SQLException on any kind of SQL error

    79      */

    80     List<IssueComment> listComments(Issue issue) throws SQLException;

    82     /**

    83      * Stores the specified comment in database.

    84      * This is an update-or-insert operation.

    85      *

    86      * @param issue the issue to save the comment for

    87      * @param comment the comment to save

    88      * @throws SQLException on any kind of SQL error

    89      */

    90     void saveComment(Issue issue, IssueComment comment) throws SQLException;

    92     /**

    93      * Saves an instances to the database.

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

    95      *

    96      * @param instance the instance to insert

    97      * @param project the parent project

    98      * @throws SQLException on any kind of SQL error

    99      * @see Issue#setId(int)

   100      */

   101     @Override

   102     void save(Issue instance, Project project) throws SQLException;

   104     /**

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

   106      *

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

   108      * @throws SQLException on any kind of SQL error

   109      */

   110     void joinVersionInformation(Issue issue) throws SQLException;

   111 }

Mercurial > hg > LightPIT / file revision