LightPIT: src/main/kotlin/de/uapcore/lightpit/dao/DataAccessObject.kt@c1be672af7ff

     1 /*

     2  * Copyright 2021 Mike Becker. All rights reserved.

     3  *

     4  * Redistribution and use in source and binary forms, with or without

     5  * modification, are permitted provided that the following conditions are met:

     6  *

     7  * 1. Redistributions of source code must retain the above copyright

     8  * notice, this list of conditions and the following disclaimer.

     9  *

    10  * 2. Redistributions in binary form must reproduce the above copyright

    11  * notice, this list of conditions and the following disclaimer in the

    12  * documentation and/or other materials provided with the distribution.

    13  *

    14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    17  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

    18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

    19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

    20  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

    21  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    22  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    24  */

    26 package de.uapcore.lightpit.dao

    28 import de.uapcore.lightpit.entities.*

    29 import de.uapcore.lightpit.viewmodel.ComponentSummary

    30 import de.uapcore.lightpit.viewmodel.IssueSummary

    31 import de.uapcore.lightpit.viewmodel.VersionSummary

    33 interface DataAccessObject {

    35     fun listUsers(): List<User>

    36     fun findUser(id: Int): User?

    37     fun findUserByName(username: String): User?

    38     fun insertUser(user: User)

    39     fun updateUser(user: User)

    41     /**

    42      * Lists all versions of the specified [project].

    43      *

    44      * The list is first ordered by the ordinal of the version and

    45      * then by name, both descending.

    46      */

    47     fun listVersions(project: Project): List<Version>

    48     fun listVersionSummaries(project: Project): List<VersionSummary>

    49     fun findVersion(id: Int): Version?

    50     fun findVersionByNode(project: Project, node: String): Version?

    51     fun insertVersion(version: Version)

    52     fun updateVersion(version: Version)

    54     fun listComponents(project: Project): List<Component>

    55     fun listComponentSummaries(project: Project): List<ComponentSummary>

    56     fun findComponent(id: Int): Component?

    57     fun findComponentByNode(project: Project, node: String): Component?

    58     fun insertComponent(component: Component)

    59     fun updateComponent(component: Component)

    61     /**

    62      * Lists all projects ordered by name.

    63      */

    64     fun listProjects(): List<Project>

    65     fun findProject(id: Int): Project?

    66     fun findProjectByNode(node: String): Project?

    67     fun insertProject(project: Project)

    68     fun updateProject(project: Project)

    70     fun collectIssueSummary(project: Project): IssueSummary

    71     fun collectIssueSummary(assignee: User): IssueSummary

    73     fun listIssues(project: Project, version: Version?, component: Component?): List<Issue>

    74     fun findIssue(id: Int): Issue?

    75     fun insertIssue(issue: Issue): Int

    76     fun updateIssue(issue: Issue)

    78     fun listComments(issue: Issue): List<IssueComment>

    79     fun findComment(id: Int): IssueComment?

    80     fun insertComment(issueComment: IssueComment): Int

    81     fun updateComment(issueComment: IssueComment)

    83     fun insertHistoryEvent(issue: Issue, newId: Int = 0)

    84     fun insertHistoryEvent(issue: Issue, issueComment: IssueComment, newId: Int = 0)

    86     /**

    87      * Lists the issue history of the project with [projectId] for the past [days].

    88      */

    89     fun listIssueHistory(projectId: Int, days: Int): List<IssueHistoryEntry>

    91     /**

    92      * Lists the issue comment history of the project with [projectId] for the past [days].

    93      */

    94     fun listIssueCommentHistory(projectId: Int, days: Int): List<IssueCommentHistoryEntry>

    95 }

Mercurial > hg > LightPIT / file revision