LightPIT: src/main/kotlin/de/uapcore/lightpit/dao/AbstractEntityDao.kt@86b5d8a1662f

     1 /*

     2  * Copyright 2020 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  *

    25  */

    27 package de.uapcore.lightpit.dao

    29 abstract class AbstractEntityDao<T> : AbstractDao<T>() {

    31     /**

    32      * Lists all entities.

    33      * @return a list of all entities

    34      */

    35     abstract fun list(): List<T>

    37     /**

    38      * Finds an entity by its integer ID.

    39      * It is not guaranteed that referenced entities are automatically joined.

    40      *

    41      * @param id the id

    42      * @return the entity or null if there is no such entity

    43      */

    44     abstract fun find(id: Int): T?

    46     /**

    47      * Inserts an instance into database.

    48      * It is not guaranteed that generated fields will be updated in the instance.

    49      *

    50      * @param instance the instance to insert

    51      */

    52     abstract fun save(instance: T)

    54     /**

    55      * Updates an instance in the database.

    56      *

    57      * @param instance the instance to update

    58      * @return true if an instance has been updated, false if the instance is not present in database

    59      */

    60     abstract fun update(instance: T): Boolean

    61 }

Mercurial > hg > LightPIT / file revision