X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fdemoscenemusic%2Fdata%2FTrack.java;h=cb9249fd97883a3a0ce9f0df0f658902dad3968c;hb=1e2c5a3d82db1f6c93adddd79b77278222979eca;hp=ace6bd349eecde12a1ac3d25b4f00d4777d79500;hpb=7da3008f2142348efd4efc21c5ce36a018227d6e;p=demoscenemusic.git

diff --git a/src/main/java/net/pterodactylus/demoscenemusic/data/Track.java b/src/main/java/net/pterodactylus/demoscenemusic/data/Track.java
index ace6bd3..cb9249f 100644
--- a/src/main/java/net/pterodactylus/demoscenemusic/data/Track.java
+++ b/src/main/java/net/pterodactylus/demoscenemusic/data/Track.java
@@ -19,24 +19,163 @@ package net.pterodactylus.demoscenemusic.data;
 
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 
 /**
- * TODO
+ * Data interface for tracks.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public interface Track extends Base {
 
+	/**
+	 * Defines relationships between tracks.
+	 *
+	 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+	 */
+	public enum Relationship {
+
+		/** The track is the original of a related track. */
+		original,
+
+		/** The track is a remix of a related track. */
+		remix,
+
+		/** The track is a cover version of a related track. */
+		cover,
+
+	}
+
+	/**
+	 * Returns the name of this track.
+	 *
+	 * @return The name of this track
+	 */
 	public String getName();
 
+	/**
+	 * Sets the name of this track.
+	 *
+	 * @param name
+	 *            The name of this track
+	 * @return This track
+	 */
 	public Track setName(String name);
 
+	/**
+	 * Returns all artists involved in this track.
+	 *
+	 * @return All involved artists in preferred order
+	 */
 	public List<Artist> getArtists();
 
+	/**
+	 * Sets all artists involved in this track.
+	 *
+	 * @param artists
+	 *            All involved artists in preferred order
+	 * @return This track
+	 */
 	public Track setArtists(List<Artist> artists);
 
+	/**
+	 * Returns all styles of this track.
+	 *
+	 * @return All styles of this track
+	 */
 	public Collection<Style> getStyles();
 
+	/**
+	 * Sets all styles of this track.
+	 *
+	 * @param styles
+	 *            All styles of this track
+	 * @return This track
+	 */
 	public Track setStyles(Collection<? extends Style> styles);
 
+	/**
+	 * Returns the name of this remix. If this track is not a remix,
+	 * {@code null} is returned.
+	 *
+	 * @return The name of this remix, or {@code null} if this track is not a
+	 *         remix
+	 */
+	public String getRemix();
+
+	/**
+	 * Sets the name of the remix.
+	 *
+	 * @param remix
+	 *            The name of this remix, or {@code null} if this track is not a
+	 *            remix
+	 * @return This track
+	 */
+	public Track setRemix(String remix);
+
+	/**
+	 * Returns all remix artists involved in this track.
+	 *
+	 * @return All remix artists involved in this track
+	 */
+	public List<Artist> getRemixArtists();
+
+	/**
+	 * Sets all remix artists involved in this track.
+	 *
+	 * @param remixArtists
+	 *            All remix artists involved in this track
+	 * @return This track
+	 */
+	public Track setRemixArtists(List<Artist> remixArtists);
+
+	/**
+	 * Returns all derivatives of this track. A derivative of a MOD file could
+	 * be a WAV or MP3 file.
+	 *
+	 * @return All derivatives of this track
+	 */
+	public Collection<TrackDerivative> getDerivatives();
+
+	/**
+	 * Sets the derivatives of this track.
+	 *
+	 * @param derivatives
+	 *            The derivatives of this track
+	 * @return This track
+	 */
+	public Track setDerivatives(Collection<TrackDerivative> derivatives);
+
+	/**
+	 * Returns all tracks that are somehow related to this track.
+	 *
+	 * @return All tracks that are related to this track
+	 */
+	public Map<Relationship, Collection<Track>> getRelatedTracks();
+
+	/**
+	 * Sets all related tracks.
+	 *
+	 * @param relatedTracks
+	 *            All related tracks
+	 * @return This track
+	 */
+	public Track setRelatedTracks(Map<Relationship, Collection<Track>> relatedTracks);
+
+	/**
+	 * Returns all parties this track was released at.
+	 *
+	 * @return All parties this track was released at
+	 */
+	public Collection<Party> getParties();
+
+	/**
+	 * Sets all parties this track was released at.
+	 *
+	 * @param parties
+	 *            All parties this track was released at
+	 * @return This track
+	 */
+	public Track setParties(Collection<Party> parties);
+
 }