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         /** Privilege level for site gods. */
  30         public static final int LEVEL_GOD = 100;
  31
  32         /** Privilege level for normal users. */
  33         public static final int LEVEL_USER = 0;
  34
  35         /**
  36          * Returns the name of this user.
  37          *
  38          * @return The name of this user
  39          */
  40         public String getName();
  41
  42         /**
  43          * Sets the name of this user.
  44          *
  45          * @param name
  46          *            The name of this user
  47          * @return This user
  48          */
  49         public User setName(String name);
  50
  51         /**
  52          * Returns the privilege level of this user. 0 is the level of a normal user
  53          * without any special privileges.
  54          *
  55          * @return The privilege level of this user
  56          */
  57         public int getLevel();
  58
  59         /**
  60          * Sets the privilege level of this user.
  61          *
  62          * @param level
  63          *            The privilege level of this user
  64          * @return This user
  65          */
  66         public User setLevel(int level);
  67
  68         /**
  69          * Returns all OpenIDs connected with this user.
  70          *
  71          * @return All OpenIDs connected with this user
  72          */
  73         public Collection<String> getOpenIds();
  74
  75         /**
  76          * Sets all OpenIDs connected with this user.
  77          *
  78          * @param openIds
  79          *            All OpenIDs connected with this user
  80          * @return This user
  81          */
  82         public User setOpenIds(Collection<String> openIds);
  83
  84 }