src/main/kotlin/de/uapcore/lightpit/dao/AbstractIssueDao.kt

changeset 167
3f30adba1c63
parent 166
6eede6088d41
child 168
1c3694ae224c
child 169
672982f54677
     1.1 --- a/src/main/kotlin/de/uapcore/lightpit/dao/AbstractIssueDao.kt	Sun Dec 20 11:06:25 2020 +0100
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,100 +0,0 @@
     1.4 -/*
     1.5 - * Copyright 2020 Mike Becker. All rights reserved.
     1.6 - *
     1.7 - * Redistribution and use in source and binary forms, with or without
     1.8 - * modification, are permitted provided that the following conditions are met:
     1.9 - *
    1.10 - * 1. Redistributions of source code must retain the above copyright
    1.11 - * notice, this list of conditions and the following disclaimer.
    1.12 - *
    1.13 - * 2. Redistributions in binary form must reproduce the above copyright
    1.14 - * notice, this list of conditions and the following disclaimer in the
    1.15 - * documentation and/or other materials provided with the distribution.
    1.16 - *
    1.17 - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    1.18 - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    1.19 - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    1.20 - * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
    1.21 - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    1.22 - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    1.23 - * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    1.24 - * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    1.25 - * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    1.26 - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.27 - *
    1.28 - */
    1.29 -
    1.30 -package de.uapcore.lightpit.dao
    1.31 -
    1.32 -import de.uapcore.lightpit.entities.*
    1.33 -import java.sql.SQLException
    1.34 -
    1.35 -abstract class AbstractIssueDao : AbstractChildEntityDao<Issue, Project>() {
    1.36 -
    1.37 -    /**
    1.38 -     * Lists all issues that are related to the specified component and version.
    1.39 -     * If component or version is null, search for issues that are not assigned to any
    1.40 -     * component or version, respectively.
    1.41 -     *
    1.42 -     * @param project the project
    1.43 -     * @param component the component
    1.44 -     * @param version the version
    1.45 -     * @return a list of issues
    1.46 -     */
    1.47 -    abstract fun list(project: Project, component: Component?, version: Version?): List<Issue>
    1.48 -
    1.49 -    /**
    1.50 -     * Lists all issues that are related to the specified version.
    1.51 -     * If the version is null, lists issues that are not assigned to any version.
    1.52 -     *
    1.53 -     * @param project the project
    1.54 -     * @param version the version or null
    1.55 -     * @return a list of issues
    1.56 -     */
    1.57 -    abstract fun list(project: Project, version: Version?): List<Issue>
    1.58 -
    1.59 -    /**
    1.60 -     * Lists all issues that are related to the specified component.
    1.61 -     * If the component is null, lists issues that are not assigned to a component.
    1.62 -     *
    1.63 -     * @param project the project
    1.64 -     * @param component the component or null
    1.65 -     * @return a list of issues
    1.66 -     */
    1.67 -    abstract fun list(project: Project, component: Component?): List<Issue>
    1.68 -
    1.69 -    /**
    1.70 -     * Lists all comments for a specific issue in chronological order.
    1.71 -     *
    1.72 -     * @param issue the issue
    1.73 -     * @return the list of comments
    1.74 -     */
    1.75 -    abstract fun listComments(issue: Issue): List<IssueComment>
    1.76 -
    1.77 -    /**
    1.78 -     * Stores the specified comment in database.
    1.79 -     * This is an update-or-insert operation.
    1.80 -     * The "updated" date of the corresponding issue is also updated.
    1.81 -     *
    1.82 -     * @param issue the issue to save the comment for
    1.83 -     * @param comment the comment to save
    1.84 -     */
    1.85 -    abstract fun saveComment(issue: Issue, comment: IssueComment)
    1.86 -
    1.87 -    /**
    1.88 -     * Saves an instances to the database.
    1.89 -     * Implementations of this DAO must guarantee that the generated ID is stored in the instance.
    1.90 -     *
    1.91 -     * @param instance the instance to insert
    1.92 -     * @param parent the parent project
    1.93 -     * @throws SQLException on any kind of SQL error
    1.94 -     */
    1.95 -    abstract override fun save(instance: Issue, parent: Project)
    1.96 -
    1.97 -    /**
    1.98 -     * Retrieves the affected, scheduled and resolved versions for the specified issue.
    1.99 -     *
   1.100 -     * @param issue the issue to join the information for
   1.101 -     */
   1.102 -    abstract fun joinVersionInformation(issue: Issue)
   1.103 -}
   1.104 \ No newline at end of file

mercurial