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

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

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

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

    36 import java.sql.SQLException;

    37 import java.util.List;

    39 public interface IssueDao extends GenericDao<Issue> {

    41     /**

    42      * Lists all issues for the specified project.

    43      * This is not guaranteed to contain version information.

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

    45      *

    46      * @param project the project

    47      * @return a list of issues

    48      * @throws SQLException on any kind of SQL error

    49      */

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

    52     /**

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

    54      * If version is null, search for issues that are not related to any version.

    55      *

    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(Version version) throws SQLException;

    62     /**

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

    64      *

    65      * @param issue the issue

    66      * @return the list of comments

    67      * @throws SQLException on any kind of SQL error

    68      */

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

    71     /**

    72      * Stores the specified comment in database.

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

    74      *

    75      * @param comment the comment to save

    76      * @throws SQLException on any kind of SQL error

    77      */

    78     void saveComment(IssueComment comment) throws SQLException;

    80     /**

    81      * Saves an instances to the database.

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

    83      *

    84      * @param instance the instance to insert

    85      * @throws SQLException on any kind of SQL error

    86      * @see Issue#setId(int)

    87      */

    88     @Override

    89     void save(Issue instance) throws SQLException;

    91     /**

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

    93      *

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

    95      * @throws SQLException on any kind of SQL error

    96      */

    97     void joinVersionInformation(Issue issue) throws SQLException;

    98 }

Mercurial > hg > LightPIT / file revision