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 the privilege level of this user. 0 is the level of a normal user
  47          * without any special privileges.
  48          *
  49          * @return The privilege level of this user
  50          */
  51         public int getLevel();
  52
  53         /**
  54          * Sets the privilege level of this user.
  55          *
  56          * @param level
  57          *            The privilege level of this user
  58          * @return This user
  59          */
  60         public User setLevel(int level);
  61
  62         /**
  63          * Returns all OpenIDs connected with this user.
  64          *
  65          * @return All OpenIDs connected with this user
  66          */
  67         public Collection<String> getOpenIds();
  68
  69         /**
  70          * Sets all OpenIDs connected with this user.
  71          *
  72          * @param openIds
  73          *            All OpenIDs connected with this user
  74          * @return This user
  75          */
  76         public User setOpenIds(Collection<String> openIds);
  77
  78 }