Merge branch 'master' into next
[Sone.git] / src / main / java / net / pterodactylus / sone / database / PostProvider.java
1 /*
2  * Sone - PostProvider.java - Copyright © 2011–2013 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.Collection;
21
22 import net.pterodactylus.sone.data.Post;
23
24 import com.google.common.base.Optional;
25
26 /**
27  * Interface for objects that can provide {@link Post}s by their ID.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public interface PostProvider {
32
33         /**
34          * Returns the post with the given ID.
35          *
36          * @param postId
37          *            The ID of the post to return
38          * @return The post with the given ID, or {@code null}
39          */
40         public Optional<Post> getPost(String postId);
41
42         /**
43          * Returns all posts from the given Sone.
44          *
45          * @param soneId
46          *            The ID of the Sone
47          * @return All posts from the given Sone
48          */
49         public Collection<Post> getPosts(String soneId);
50
51         /**
52          * Returns all posts that have the given Sone as recipient.
53          *
54          * @see Post#getRecipient()
55          * @param recipientId
56          *            The ID of the recipient of the posts
57          * @return All posts that have the given Sone as recipient
58          */
59         public Collection<Post> getDirectedPosts(String recipientId);
60
61 }