src/main/kotlin/de/uapcore/lightpit/dao/AbstractEntityDao.kt@86b5d8a1662f (annotated)
src/main/kotlin/de/uapcore/lightpit/dao/AbstractEntityDao.kt
Thu, 19 Nov 2020 13:58:54 +0100
- author
- mike@uapl01.localdomain
- date
- Thu, 19 Nov 2020 13:58:54 +0100
- changeset 159
- 86b5d8a1662f
- permissions
- -rw-r--r--
migrates DAO classes
| mike@159 | 1 | /* |
| mike@159 | 2 | * Copyright 2020 Mike Becker. All rights reserved. |
| mike@159 | 3 | * |
| mike@159 | 4 | * Redistribution and use in source and binary forms, with or without |
| mike@159 | 5 | * modification, are permitted provided that the following conditions are met: |
| mike@159 | 6 | * |
| mike@159 | 7 | * 1. Redistributions of source code must retain the above copyright |
| mike@159 | 8 | * notice, this list of conditions and the following disclaimer. |
| mike@159 | 9 | * |
| mike@159 | 10 | * 2. Redistributions in binary form must reproduce the above copyright |
| mike@159 | 11 | * notice, this list of conditions and the following disclaimer in the |
| mike@159 | 12 | * documentation and/or other materials provided with the distribution. |
| mike@159 | 13 | * |
| mike@159 | 14 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| mike@159 | 15 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| mike@159 | 16 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| mike@159 | 17 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| mike@159 | 18 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| mike@159 | 19 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| mike@159 | 20 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| mike@159 | 21 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| mike@159 | 22 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| mike@159 | 23 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| mike@159 | 24 | * |
| mike@159 | 25 | */ |
| mike@159 | 26 | |
| mike@159 | 27 | package de.uapcore.lightpit.dao |
| mike@159 | 28 | |
| mike@159 | 29 | abstract class AbstractEntityDao<T> : AbstractDao<T>() { |
| mike@159 | 30 | |
| mike@159 | 31 | /** |
| mike@159 | 32 | * Lists all entities. |
| mike@159 | 33 | * @return a list of all entities |
| mike@159 | 34 | */ |
| mike@159 | 35 | abstract fun list(): List<T> |
| mike@159 | 36 | |
| mike@159 | 37 | /** |
| mike@159 | 38 | * Finds an entity by its integer ID. |
| mike@159 | 39 | * It is not guaranteed that referenced entities are automatically joined. |
| mike@159 | 40 | * |
| mike@159 | 41 | * @param id the id |
| mike@159 | 42 | * @return the entity or null if there is no such entity |
| mike@159 | 43 | */ |
| mike@159 | 44 | abstract fun find(id: Int): T? |
| mike@159 | 45 | |
| mike@159 | 46 | /** |
| mike@159 | 47 | * Inserts an instance into database. |
| mike@159 | 48 | * It is not guaranteed that generated fields will be updated in the instance. |
| mike@159 | 49 | * |
| mike@159 | 50 | * @param instance the instance to insert |
| mike@159 | 51 | */ |
| mike@159 | 52 | abstract fun save(instance: T) |
| mike@159 | 53 | |
| mike@159 | 54 | /** |
| mike@159 | 55 | * Updates an instance in the database. |
| mike@159 | 56 | * |
| mike@159 | 57 | * @param instance the instance to update |
| mike@159 | 58 | * @return true if an instance has been updated, false if the instance is not present in database |
| mike@159 | 59 | */ |
| mike@159 | 60 | abstract fun update(instance: T): Boolean |
| mike@159 | 61 | } |
