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

Mon, 01 Jun 2020 14:46:58 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 01 Jun 2020 14:46:58 +0200
changeset 86
0a658e53177c
parent 75
33b6843fdf8a
child 105
250c5cbb8276
permissions
-rw-r--r--

improves issue overview and adds progress information

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@38 32 import de.uapcore.lightpit.entities.Project;
universe@86 33 import de.uapcore.lightpit.entities.Version;
universe@38 34
universe@59 35 import java.sql.SQLException;
universe@59 36 import java.util.List;
universe@59 37
universe@62 38 public interface IssueDao extends GenericDao<Issue> {
universe@59 39
universe@59 40 /**
universe@62 41 * Lists all issues for the specified project.
universe@75 42 * This is not guaranteed to contain version information.
universe@75 43 * Use {@link #joinVersionInformation(Issue)} to obtain this information for a specific issue.
universe@72 44 *
universe@59 45 * @param project the project
universe@62 46 * @return a list of issues
universe@59 47 * @throws SQLException on any kind of SQL error
universe@59 48 */
universe@62 49 List<Issue> list(Project project) throws SQLException;
universe@75 50
universe@75 51 /**
universe@86 52 * Lists all issues that are somehow related to the specified version.
universe@86 53 *
universe@86 54 * @param version the version
universe@86 55 * @return a list of issues
universe@86 56 * @throws SQLException on any kind of SQL error
universe@86 57 */
universe@86 58 List<Issue> list(Version version) throws SQLException;
universe@86 59
universe@86 60 /**
universe@75 61 * Saves an instances to the database.
universe@75 62 * Implementations of this DAO must guarantee that the generated ID is stored in the instance.
universe@75 63 *
universe@75 64 * @param instance the instance to insert
universe@75 65 * @throws SQLException on any kind of SQL error
universe@75 66 * @see Issue#setId(int)
universe@75 67 */
universe@75 68 @Override
universe@75 69 void save(Issue instance) throws SQLException;
universe@75 70
universe@75 71 /**
universe@75 72 * Retrieves the affected, scheduled and resolved versions for the specified issue.
universe@75 73 *
universe@75 74 * @param issue the issue to join the information for
universe@75 75 * @throws SQLException on any kind of SQL error
universe@75 76 */
universe@75 77 void joinVersionInformation(Issue issue) throws SQLException;
universe@38 78 }

mercurial