Package de.damios.jpapi.model

Class Project

java.lang.Object

de.damios.jpapi.model.Project

All Implemented Interfaces:

java.io.Serializable

public class Project
extends java.lang.Object
implements java.io.Serializable

Java-Modell des JSON-Projekt-Objekts.

Die zentrale Klasse zum Umgang mit den Spielen auf Pewn.

Since:

0.1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Project.OrderedBy	Gibt die Reihenfolge an, in der Spiele sortiert sein sollen.

Constructor Summary

Constructors

Constructor	Description
Project()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAdvertisement()	Liefert die Kurzbeschreibung des Spiels.
static Project[]	getAll(Project.OrderedBy ord)	Liefert alle Spiele auf Pewn in einer bestimmten Reihenfolge.
User	getAuthor()	Liefert den Ersteller des Spiels.
static Project	getByProjectId(long gameid)	Liefert ein bestimmtes Spiel anhand dessen individueller ID.
static Project[]	getByUserId(long userId)	Liefert alle Spiele eines bestimmten Nutzers, aufsteigend nach Erstellungsdatum sortiert.
java.sql.Timestamp	getCreationDate()
java.lang.String	getDescriptionText()
Hashtag[]	getHashtags()	Liefert alle Hashtags, die mit dem Spiel verknüpft sind.
long	getId()
Image[]	getImages()	Liefert alle Bilder, die dem Spiel zugeordnet sind.
static Project[]	getInLatestBox()	Liefert alle Spiele in der 'Neueste Spiele'-Box auf der Startseite.
static Project[]	getInMostViewedBox()	Liefert alle Spiele in der 'Am meisten gesehen'-Box auf der Startseite.
java.sql.Timestamp	getLastUpdateDate()
static Project	getLatest()	Liefert das neueste Spiel.
static Project[]	getLikedProjectsByUserId(long userId)	Liefert alle Spiele, die ein bestimmter Benutzer gelikt hat.
java.lang.String	getName()	Liefert den Namen des Spiels.
static Project	getRandom()	Liefert ein zufälliges Spiel.
int	getRating()	Liefert die Durchschnitts-Bewertung des Spiels.
Rating[]	getRatings()	Liefert alle Bewertungen eines Spiels.
static Project[]	getRecommendedProjectsByProjectId(int gameid)	Liefert ein Array aller Empfehlungen zu einem Spiel.
Team	getTeam()	Liefert das Entwickler-Team, dem das Projekt gehört.
java.lang.String	getVersion()	Liefert die Version des Spiels.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Project

public Project()

Method Detail

getId

public long getId()

Returns:

Liefert die individuelle ID des Spiels.

See Also:

id

getDescriptionText

public java.lang.String getDescriptionText()

Returns:

Liefert die Beschreibung des Spiels auf Pewn.

See Also:

getHashtags()

getName

public java.lang.String getName()

Liefert den Namen des Spiels.

Der Name kann jederzeit geändert werden und sollte daher nicht als Identifikationsmerkmal für Spiele verwendet werden.

Returns:

Der Projektname.

getCreationDate

public java.sql.Timestamp getCreationDate()

Returns:

Liefert das Erstellungsdatum des Spiels.

getLastUpdateDate

public java.sql.Timestamp getLastUpdateDate()

Returns:

Liefert den Zeitpunkt des letzten Updates.

getAuthor

public User getAuthor()

Liefert den Ersteller des Spiels.

Sofern das Spiel nicht einem Entwickler-Team zugewiesen ist, ist der Ersteller auch der Entwickler. Der Ersteller hat umfangreichere Befugnisse als andere Entwickler des Spiels.

Returns:

Ersteller des Spiels.

getTeam

public Team getTeam()

Liefert das Entwickler-Team, dem das Projekt gehört.

Returns:

Das Entwickler-Team.

See Also:

getAuthor()

getRating

public int getRating()

Liefert die Durchschnitts-Bewertung des Spiels.

Returns:

Die Durchschnitts-Bewertung des Spiels (Nachkommastellen weggelassen).

getVersion

public java.lang.String getVersion()

Liefert die Version des Spiels.

Es gibt keinerlei Vorgaben zum Format der Versionierung.

Returns:

Die Version.

getImages

public Image[] getImages()

Liefert alle Bilder, die dem Spiel zugeordnet sind.

Returns:

Alle zugeordneten Bilder; wenn ein Projekt keine Bilder besitzt, ein leeres Array.

getRatings

public Rating[] getRatings()
                    throws java.io.IOException

Liefert alle Bewertungen eines Spiels.

Returns:

Die Bewertungen als Rating-Array; wenn ein Projekt noch keine Bewertung erhalten hat, ein leeres Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Rating.getByProjectId(long)

getHashtags

public Hashtag[] getHashtags()

Liefert alle Hashtags, die mit dem Spiel verknüpft sind.

Returns:

Die Hashtags als Hashtag-Array; wenn ein Projekt mit keinerlei Hashtags versehen ist, ein leeres Array.

See Also:

Hashtag.getByProjectId(long)

getAdvertisement

public java.lang.String getAdvertisement()

Liefert die Kurzbeschreibung des Spiels.

Returns:

Die Kurzbeschreibung; zwischen 45 und 250 Zeichen lang.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getByProjectId

public static Project getByProjectId(long gameid)
                              throws java.io.IOException

Liefert ein bestimmtes Spiel anhand dessen individueller ID.

Parameters:

gameid - Die Spiele-ID.

Returns:

Das Spiel; null, wenn das Spiel nicht existiert.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getByUserId

public static Project[] getByUserId(long userId)
                             throws java.io.IOException

Liefert alle Spiele eines bestimmten Nutzers, aufsteigend nach Erstellungsdatum sortiert.

Parameters:

userId - Die ID des Entwicklers, dessen Spiele abgerufen werden sollen.

Returns:

Die Spiele als Project-Array; wenn ein Nutzer keine Spiele hat, ein leeres Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getLikedProjectsByUserId

public static Project[] getLikedProjectsByUserId(long userId)
                                          throws java.io.IOException

Liefert alle Spiele, die ein bestimmter Benutzer gelikt hat.

Parameters:

userId - Die ID des Entwicklers, dessen gelikte Spiele abgerufen werden sollen.

Returns:

Die Spiele als Project-Array; wenn ein Nutzer keine Spiele geliket hat, ein leeres Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getLatest

public static Project getLatest()
                         throws java.io.IOException

Liefert das neueste Spiel.

Returns:

Das Spiel.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getRandom

public static Project getRandom()
                         throws java.io.IOException

Liefert ein zufälliges Spiel.

Returns:

Das Spiel.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getAll

public static Project[] getAll(Project.OrderedBy ord)
                        throws java.io.IOException

Liefert alle Spiele auf Pewn in einer bestimmten Reihenfolge.

Parameters:

ord - Reihenfolge, in der die Spiele sortiert sein sollen.

Returns:

Alle Spiele als Project-Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getInLatestBox

public static Project[] getInLatestBox()
                                throws java.io.IOException

Liefert alle Spiele in der 'Neueste Spiele'-Box auf der Startseite.

Returns:

Alle Spiele als Project-Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getInMostViewedBox

public static Project[] getInMostViewedBox()
                                    throws java.io.IOException

Liefert alle Spiele in der 'Am meisten gesehen'-Box auf der Startseite.

Returns:

Alle Spiele als Project-Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)

getRecommendedProjectsByProjectId

public static Project[] getRecommendedProjectsByProjectId(int gameid)
                                                   throws java.io.IOException

Liefert ein Array aller Empfehlungen zu einem Spiel.

Parameters:

gameid - Die Spiele-ID.

Returns:

Alle empfohlenen Spiele als Project-Array.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Api.executeCall(Call)