1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/main/kotlin/de/uapcore/lightpit/dao/AbstractChildEntityDao.kt Thu Nov 19 13:58:54 2020 +0100 1.3 @@ -0,0 +1,64 @@ 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 + 1.33 +abstract class AbstractChildEntityDao<T, P> : AbstractDao<T>() { 1.34 + 1.35 + /** 1.36 + * Lists all entities being a child of the specified parent. 1.37 + * @param parent the parent 1.38 + * @return the list of child instances 1.39 + */ 1.40 + abstract fun list(parent: P): List<T> 1.41 + 1.42 + /** 1.43 + * Finds an entity by its integer ID. 1.44 + * It is not guaranteed that referenced entities are automatically joined. 1.45 + * 1.46 + * @param id the id 1.47 + * @return the entity or null if there is no such entity 1.48 + */ 1.49 + abstract fun find(id: Int): T? 1.50 + 1.51 + /** 1.52 + * Inserts an instance into database. 1.53 + * It is not guaranteed that generated fields will be updated in the instance. 1.54 + * 1.55 + * @param instance the instance to insert 1.56 + * @param parent a reference to the parent 1.57 + */ 1.58 + abstract fun save(instance: T, parent: P) 1.59 + 1.60 + /** 1.61 + * Updates an instance in the database. 1.62 + * 1.63 + * @param instance the instance to update 1.64 + * @return true if an instance has been updated, false if the instance is not present in database 1.65 + */ 1.66 + abstract fun update(instance: T): Boolean 1.67 +}