Add unit test for unbookmark page, fix bug in page implementation
[Sone.git] / src / main / java / net / pterodactylus / sone / database / PostReplyProvider.java
1 /*
2  * Sone - PostReplyProvider.java - Copyright © 2013–2016 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 java.util.List;
21
22 import net.pterodactylus.sone.data.PostReply;
23
24 import com.google.common.base.Optional;
25
26 /**
27  * Interface for objects that can provide {@link PostReply}s.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public interface PostReplyProvider {
32
33         /**
34          * Returns the reply with the given ID.
35          *
36          * @param id
37          *            The ID of the reply to get
38          * @return The reply, or {@code null} if there is no such reply
39          */
40         public Optional<PostReply> getPostReply(String id);
41
42         /**
43          * Returns all replies for the given post, order ascending by time.
44          *
45          * @param postId
46          *            The ID of the post to get all replies for
47          * @return All replies for the given post
48          */
49         public List<PostReply> getReplies(String postId);
50
51 }