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

Fri, 09 Oct 2020 19:07:05 +0200

author
Mike Becker <universe@uap-core.de>
date
Fri, 09 Oct 2020 19:07:05 +0200
changeset 124
ed2e7aef2a3e
parent 105
250c5cbb8276
child 128
947d0f6a6a83
permissions
-rw-r--r--

adds issue comments

universe@38 1 /*
universe@38 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@38 3 *
universe@38 4 * Copyright 2018 Mike Becker. All rights reserved.
universe@38 5 *
universe@38 6 * Redistribution and use in source and binary forms, with or without
universe@38 7 * modification, are permitted provided that the following conditions are met:
universe@38 8 *
universe@38 9 * 1. Redistributions of source code must retain the above copyright
universe@38 10 * notice, this list of conditions and the following disclaimer.
universe@38 11 *
universe@38 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@38 13 * notice, this list of conditions and the following disclaimer in the
universe@38 14 * documentation and/or other materials provided with the distribution.
universe@38 15 *
universe@38 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@38 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@38 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@38 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@38 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@38 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@38 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@38 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@38 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@38 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@38 26 * POSSIBILITY OF SUCH DAMAGE.
universe@38 27 *
universe@38 28 */
universe@38 29 package de.uapcore.lightpit.dao;
universe@38 30
universe@62 31 import de.uapcore.lightpit.entities.Issue;
universe@124 32 import de.uapcore.lightpit.entities.IssueComment;
universe@38 33 import de.uapcore.lightpit.entities.Project;
universe@86 34 import de.uapcore.lightpit.entities.Version;
universe@38 35
universe@59 36 import java.sql.SQLException;
universe@59 37 import java.util.List;
universe@59 38
universe@62 39 public interface IssueDao extends GenericDao<Issue> {
universe@59 40
universe@59 41 /**
universe@62 42 * Lists all issues for the specified project.
universe@75 43 * This is not guaranteed to contain version information.
universe@75 44 * Use {@link #joinVersionInformation(Issue)} to obtain this information for a specific issue.
universe@72 45 *
universe@59 46 * @param project the project
universe@62 47 * @return a list of issues
universe@59 48 * @throws SQLException on any kind of SQL error
universe@59 49 */
universe@62 50 List<Issue> list(Project project) throws SQLException;
universe@75 51
universe@75 52 /**
universe@86 53 * Lists all issues that are somehow related to the specified version.
universe@105 54 * If version is null, search for issues that are not related to any version.
universe@86 55 *
universe@105 56 * @param version the version or null
universe@86 57 * @return a list of issues
universe@86 58 * @throws SQLException on any kind of SQL error
universe@86 59 */
universe@86 60 List<Issue> list(Version version) throws SQLException;
universe@86 61
universe@86 62 /**
universe@124 63 * Lists all comments for a specific issue in chronological order.
universe@124 64 *
universe@124 65 * @param issue the issue
universe@124 66 * @return the list of comments
universe@124 67 * @throws SQLException on any kind of SQL error
universe@124 68 */
universe@124 69 List<IssueComment> listComments(Issue issue) throws SQLException;
universe@124 70
universe@124 71 /**
universe@124 72 * Stores the specified comment in database.
universe@124 73 * This is an update-or-insert operation.
universe@124 74 *
universe@124 75 * @param comment the comment to save
universe@124 76 * @throws SQLException on any kind of SQL error
universe@124 77 */
universe@124 78 void saveComment(IssueComment comment) throws SQLException;
universe@124 79
universe@124 80 /**
universe@75 81 * Saves an instances to the database.
universe@75 82 * Implementations of this DAO must guarantee that the generated ID is stored in the instance.
universe@75 83 *
universe@75 84 * @param instance the instance to insert
universe@75 85 * @throws SQLException on any kind of SQL error
universe@75 86 * @see Issue#setId(int)
universe@75 87 */
universe@75 88 @Override
universe@75 89 void save(Issue instance) throws SQLException;
universe@75 90
universe@75 91 /**
universe@75 92 * Retrieves the affected, scheduled and resolved versions for the specified issue.
universe@75 93 *
universe@75 94 * @param issue the issue to join the information for
universe@75 95 * @throws SQLException on any kind of SQL error
universe@75 96 */
universe@75 97 void joinVersionInformation(Issue issue) throws SQLException;
universe@38 98 }

mercurial