src/main/kotlin/net/pterodactylus/sone/database/PostReplyProvider.kt

   1 /*
   2  * Sone - PostReplyProvider.kt - Copyright © 2013–2019 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.database
  19
  20 import net.pterodactylus.sone.data.*
  21
  22 /**
  23  * Interface for objects that can provide [PostReply]s.
  24  */
  25 interface PostReplyProvider {
  26
  27         fun getPostReply(id: String): PostReply?
  28
  29         /**
  30          * Returns all replies for the given post, order ascending by time.
  31          *
  32          * @param postId The ID of the post to get all replies for
  33          * @return All replies for the given post
  34          */
  35         fun getReplies(postId: String): List<PostReply>
  36
  37 }