Add user data container.
[demoscenemusic.git] / src / main / java / net / pterodactylus / demoscenemusic / data / User.java
1 /*
2  * DemosceneMusic - User.java - Copyright © 2012 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.demoscenemusic.data;
19
20 import java.util.Collection;
21
22 /**
23  * Data container for users of the website.
24  *
25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
26  */
27 public interface User extends Base {
28
29         /**
30          * Returns the name of this user.
31          *
32          * @return The name of this user
33          */
34         public String getName();
35
36         /**
37          * Sets the name of this user.
38          *
39          * @param name
40          *            The name of this user
41          * @return This user
42          */
43         public User setName(String name);
44
45         /**
46          * Returns all OpenIDs connected with this user.
47          *
48          * @return All OpenIDs connected with this user
49          */
50         public Collection<String> getOpenIds();
51
52         /**
53          * Sets all OpenIDs connected with this user.
54          *
55          * @param openIds
56          *            All OpenIDs connected with this user
57          * @return This user
58          */
59         public User setOpenIds(Collection<String> openIds);
60
61 }