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