src/main/java/net/pterodactylus/demoscenemusic/data/Group.java

   1 /*
   2  * DemosceneMusic - Group.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 interface for groups.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public interface Group extends Base {
  28
  29         /**
  30          * Returns the name of this group.
  31          *
  32          * @return The name of this group
  33          */
  34         public String getName();
  35
  36         /**
  37          * Sets the name of this group.
  38          *
  39          * @param name
  40          *            The name of this group
  41          * @return This group
  42          */
  43         public Group setName(String name);
  44
  45         /**
  46          * Returns the short name of this group.
  47          *
  48          * @return The short name of this group, or {@code null} if this group does
  49          *         not have a short name
  50          */
  51         public String getShortName();
  52
  53         /**
  54          * Sets the short name of this group.
  55          *
  56          * @param shortName
  57          *            The new short name of this group
  58          * @return This group
  59          */
  60         public Group setShortName(String shortName);
  61
  62         /**
  63          * Returns all artists belonging to this group.
  64          *
  65          * @return All artists belonging to this group
  66          */
  67         public Collection<Artist> getArtists();
  68
  69         /**
  70          * Sets all artists belonging to this group.
  71          *
  72          * @param artists
  73          *            All artists belonging to this group
  74          * @return This group
  75          */
  76         public Group setArtists(Collection<Artist> artists);
  77
  78 }