Package com.treescrub.spedran.requests.builders.game

Class GameRomhacksRequest

java.lang.Object

com.treescrub.spedran.ResourceCollectionRequest<Game>

com.treescrub.spedran.requests.builders.game.GameRomhacksRequest

public class GameRomhacksRequest
extends ResourceCollectionRequest<Game>

A request builder to get all derived Games (romhacks) for a given Game.

Constructor Summary

Constructors

Constructor	Description
GameRomhacksRequest(Game game)
GameRomhacksRequest(String id)

Method Summary

Modifier and Type	Method	Description
GameRomhacksRequest	abbreviation(String abbreviation)	Sets the abbreviation to filter for.
GameRomhacksRequest	developer(Developer developer)	Sets the developer to filter for.
GameRomhacksRequest	developer(String id)	Sets the developer to filter for.
GameRomhacksRequest	engine(Engine engine)	Sets the engine to filter for.
GameRomhacksRequest	engine(String id)	Sets the engine to filter for.
GameRomhacksRequest	gameType(Gametype gametype)	Sets the gametype to filter for.
GameRomhacksRequest	gameType(String id)	Sets the gametype to filter for.
GameRomhacksRequest	genre(Genre genre)	Sets the genre to filter for.
GameRomhacksRequest	genre(String id)	Sets the genre to filter for.
GameRomhacksRequest	moderator(User user)	Sets the moderator to filter for.
GameRomhacksRequest	moderator(String id)	Sets the moderator to filter for.
GameRomhacksRequest	name(String name)	Sets the value to search across names and abbreviations.
GameRomhacksRequest	platform(Platform platform)	Sets the platform to filter for.
GameRomhacksRequest	platform(String id)	Sets the platform to filter for.
GameRomhacksRequest	publisher(Publisher publisher)	Sets the publisher to filter for.
GameRomhacksRequest	publisher(String id)	Sets the publisher to filter for.
GameRomhacksRequest	region(Region region)	Sets the region to filter for.
GameRomhacksRequest	region(String id)	Sets the region to filter for.
GameRomhacksRequest	releaseYear(int year)	Sets the release year to filter for.
GameRomhacksRequest	sortByAbbreviation()	Sorts the returned games by the abbreviation.
GameRomhacksRequest	sortByCreationDate()	Sorts the returned games by the creation time.
GameRomhacksRequest	sortByInternationalName()	Sorts the returned games by the international name.
GameRomhacksRequest	sortByJapaneseName()	Sorts the returned games by the japanese name.
GameRomhacksRequest	sortByNameSimilarity()	Sorts the returned games by name similarity.
GameRomhacksRequest	sortByReleaseDate()	Sorts the returned games by the release date.
GameRomhacksRequest	sortDirection(SortDirection direction)	Sets the direction to sort the returned games.

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest

complete

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GameRomhacksRequest

public GameRomhacksRequest(String id)

GameRomhacksRequest

public GameRomhacksRequest(Game game)

Method Detail

name

public GameRomhacksRequest name(String name)

Sets the value to search across names and abbreviations. Uses a fuzzy search.

Parameters:

name - search query

Returns:

this object

abbreviation

public GameRomhacksRequest abbreviation(String abbreviation)

Sets the abbreviation to filter for.

Parameters:

abbreviation - the game abbreviation to search for

Returns:

this object

releaseYear

public GameRomhacksRequest releaseYear(int year)

Sets the release year to filter for.

Parameters:

year - release year

Returns:

this object

gameType

public GameRomhacksRequest gameType(String id)

Sets the gametype to filter for.

Parameters:

id - the gametype ID

Returns:

this object

gameType

public GameRomhacksRequest gameType(Gametype gametype)

Sets the gametype to filter for.

Parameters:

gametype - the gametype

Returns:

this object

platform

public GameRomhacksRequest platform(String id)

Sets the platform to filter for.

Parameters:

id - the platform ID

Returns:

this object

platform

public GameRomhacksRequest platform(Platform platform)

Sets the platform to filter for.

Parameters:

platform - the platform

Returns:

this object

region

public GameRomhacksRequest region(String id)

Sets the region to filter for.

Parameters:

id - the region ID

Returns:

this object

region

public GameRomhacksRequest region(Region region)

Sets the region to filter for.

Parameters:

region - the region

Returns:

this object

genre

public GameRomhacksRequest genre(String id)

Sets the genre to filter for.

Parameters:

id - the genre id

Returns:

this object

genre

public GameRomhacksRequest genre(Genre genre)

Sets the genre to filter for.

Parameters:

genre - the genre

Returns:

this object

engine

public GameRomhacksRequest engine(String id)

Sets the engine to filter for.

Parameters:

id - the engine ID

Returns:

this object

engine

public GameRomhacksRequest engine(Engine engine)

Sets the engine to filter for.

Parameters:

engine - the engine

Returns:

this object

developer

public GameRomhacksRequest developer(String id)

Sets the developer to filter for.

Parameters:

id - the developer ID

Returns:

this object

developer

public GameRomhacksRequest developer(Developer developer)

Sets the developer to filter for.

Parameters:

developer - the developer

Returns:

this object

publisher

public GameRomhacksRequest publisher(String id)

Sets the publisher to filter for.

Parameters:

id - the publisher ID

Returns:

this object

publisher

public GameRomhacksRequest publisher(Publisher publisher)

Sets the publisher to filter for.

Parameters:

publisher - the publisher

Returns:

this object

moderator

public GameRomhacksRequest moderator(String id)

Sets the moderator to filter for.

Parameters:

id - the user ID

Returns:

this object

moderator

public GameRomhacksRequest moderator(User user)

Sets the moderator to filter for.

Parameters:

user - the user

Returns:

this object

sortByInternationalName

public GameRomhacksRequest sortByInternationalName()

Sorts the returned games by the international name.

Returns:

this object

See Also:

Game.getNames(), Names.getInternationalName()

sortByJapaneseName

public GameRomhacksRequest sortByJapaneseName()

Sorts the returned games by the japanese name.

Returns:

this object

See Also:

Game.getNames(), Names.getJapaneseName()

sortByAbbreviation

public GameRomhacksRequest sortByAbbreviation()

Sorts the returned games by the abbreviation.

Returns:

this object

See Also:

Game.getAbbreviation()

sortByReleaseDate

public GameRomhacksRequest sortByReleaseDate()

Sorts the returned games by the release date.

Returns:

this object

See Also:

Game.getReleaseDate()

sortByCreationDate

public GameRomhacksRequest sortByCreationDate()

Sorts the returned games by the creation time.

Returns:

this object

See Also:

Game.getCreationTime()

sortByNameSimilarity

public GameRomhacksRequest sortByNameSimilarity()

Sorts the returned games by name similarity.

Only works when searching by name. Will always error if not searching by name.

Returns:

this object

sortDirection

public GameRomhacksRequest sortDirection(SortDirection direction)

Sets the direction to sort the returned games.

Parameters:

direction - the direction to sort, either ascending or descending

Returns:

this object