java.lang.Object
- com.treescrub.spedran.ResourceCollectionRequest<Game>
- - com.treescrub.spedran.requests.builders.game.GamesRequest

public class GamesRequest
extends ResourceCollectionRequest<Game>

A request builder to get all Games matching the set filters.

Field Summary

Fields
Modifier and Type Field Description

static int MAX_ITEMS_BULK

Constructor Summary

Constructors
Constructor Description

GamesRequest()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GamesRequest`	`abbreviation(String abbreviation)`	Search for an exact game abbreviation.
`GamesRequest`	`asBulk()`
`GamesRequest`	`developer(Developer developer)`	Restricts the results to games with the given `Developer`.
`GamesRequest`	`developer(String id)`	Restricts the results to games with the given `Developer`.
`GamesRequest`	`engine(Engine engine)`	Restricts the results to games with the given `Engine`.
`GamesRequest`	`engine(String id)`	Restricts the results to games with the given `Engine`.
`GamesRequest`	`gameType(Gametype gametype)`	Restricts the results to games with the given `Gametype`.
`GamesRequest`	`gameType(String id)`	Restricts the results to games with the given `Gametype`.
`GamesRequest`	`genre(Genre genre)`	Restricts the results to games with the given `Genre`.
`GamesRequest`	`genre(String id)`	Restricts the results to games with the given `Genre`.
`GamesRequest`	`moderator(User user)`	Restricts the results to games where the given `User` is a moderator.
`GamesRequest`	`moderator(String id)`	Restricts the results to games where the given `User` is a moderator.
`GamesRequest`	`name(String name)`	Use a fuzzy search to filter game names and abbreviations.
`GamesRequest`	`platform(Platform platform)`	Restricts the results to games with the given `Platform`.
`GamesRequest`	`platform(String id)`	Restricts the results to games with the given `Platform`.
`GamesRequest`	`publisher(Publisher publisher)`	Restricts the results to games with the given `Publisher`.
`GamesRequest`	`publisher(String id)`	Restricts the results to games with the given `Publisher`.
`GamesRequest`	`region(Region region)`	Restricts the results to games with the given `Region`.
`GamesRequest`	`region(String id)`	Restricts the results to games with the given `Region`.
`GamesRequest`	`releaseYear(int year)`	Restricts the results to games with the given release year.
`GamesRequest`	`sortByAbbreviation()`	Sorts the results alphanumerically by the abbreviation of the games.
`GamesRequest`	`sortByCreationDate()`	Sorts the results by the creation date of the games on SRC.
`GamesRequest`	`sortByInternationalName()`	Sorts the results alphanumerically by the international name of the games.
`GamesRequest`	`sortByJapaneseName()`	Sorts the results alphanumerically by the Japanese name of the games.
`GamesRequest`	`sortByNameSimilarity()`	Sorts the results by similarity when `name(String)` is set.
`GamesRequest`	`sortByReleaseDate()`	Sorts the results by the release date of the games.
`GamesRequest`	`sortDirection(SortDirection direction)`	Sets the direction (ascending or descending) of the sorting.

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

- Field Detail
  - MAX_ITEMS_BULK
```
public static final int MAX_ITEMS_BULK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GamesRequest
```
public GamesRequest()
```
- Method Detail
  - name
```
public GamesRequest name(String name)
```
    Use a fuzzy search to filter game names and abbreviations.
    
    Parameters:
    
    name - the String to search for
    
    Returns:
    
    this GamesRequest builder
  - abbreviation
```
public GamesRequest abbreviation(String abbreviation)
```
    Search for an exact game abbreviation.
    
    Parameters:
    
    abbreviation - the abbreviation to search for
    
    Returns:
    
    this GamesRequest builder
  - releaseYear
```
public GamesRequest releaseYear(int year)
```
    Restricts the results to games with the given release year.
    
    Parameters:
    
    year - the year a game was released
    
    Returns:
    
    this GamesRequest builder
  - gameType
```
public GamesRequest gameType(String id)
```
    Restricts the results to games with the given Gametype.
    
    Parameters:
    
    id - the gametype ID
    
    Returns:
    
    this GamesRequest builder
  - gameType
```
public GamesRequest gameType(Gametype gametype)
```
    Restricts the results to games with the given Gametype.
    
    Parameters:
    
    gametype - the gametype
    
    Returns:
    
    this GamesRequest builder
  - platform
```
public GamesRequest platform(String id)
```
    Restricts the results to games with the given Platform.
    
    Parameters:
    
    id - the platform ID
    
    Returns:
    
    this GamesRequest builder
  - platform
```
public GamesRequest platform(Platform platform)
```
    Restricts the results to games with the given Platform.
    
    Parameters:
    
    platform - the platform
    
    Returns:
    
    this GamesRequest builder
  - region
```
public GamesRequest region(String id)
```
    Restricts the results to games with the given Region.
    
    Parameters:
    
    id - the region ID
    
    Returns:
    
    this GamesRequest builder
  - region
```
public GamesRequest region(Region region)
```
    Restricts the results to games with the given Region.
    
    Parameters:
    
    region - the region
    
    Returns:
    
    this GamesRequest builder
  - genre
```
public GamesRequest genre(String id)
```
    Restricts the results to games with the given Genre.
    
    Parameters:
    
    id - the genre ID
    
    Returns:
    
    this GamesRequest builder
  - genre
```
public GamesRequest genre(Genre genre)
```
    Restricts the results to games with the given Genre.
    
    Parameters:
    
    genre - the genre
    
    Returns:
    
    this GamesRequest builder
  - engine
```
public GamesRequest engine(String id)
```
    Restricts the results to games with the given Engine.
    
    Parameters:
    
    id - the engine ID
    
    Returns:
    
    this GamesRequest builder
  - engine
```
public GamesRequest engine(Engine engine)
```
    Restricts the results to games with the given Engine.
    
    Parameters:
    
    engine - the engine
    
    Returns:
    
    this GamesRequest builder
  - developer
```
public GamesRequest developer(String id)
```
    Restricts the results to games with the given Developer.
    
    Parameters:
    
    id - the developer ID
    
    Returns:
    
    this GamesRequest builder
  - developer
```
public GamesRequest developer(Developer developer)
```
    Restricts the results to games with the given Developer.
    
    Parameters:
    
    developer - the developer
    
    Returns:
    
    this GamesRequest builder
  - publisher
```
public GamesRequest publisher(String id)
```
    Restricts the results to games with the given Publisher.
    
    Parameters:
    
    id - the publisher ID
    
    Returns:
    
    this GamesRequest builder
  - publisher
```
public GamesRequest publisher(Publisher publisher)
```
    Restricts the results to games with the given Publisher.
    
    Parameters:
    
    publisher - the publisher
    
    Returns:
    
    this GamesRequest builder
  - moderator
```
public GamesRequest moderator(String id)
```
    Restricts the results to games where the given User is a moderator.
    
    Parameters:
    
    id - the user ID
    
    Returns:
    
    this GamesRequest builder
  - moderator
```
public GamesRequest moderator(User user)
```
    Restricts the results to games where the given User is a moderator.
    
    Parameters:
    
    user - the user
    
    Returns:
    
    this GamesRequest builder
  - asBulk
```
public GamesRequest asBulk()
```
  - sortByInternationalName
```
public GamesRequest sortByInternationalName()
```
    Sorts the results alphanumerically by the international name of the games.
    
    Returns:
    
    this GamesRequest builder
  - sortByJapaneseName
```
public GamesRequest sortByJapaneseName()
```
    Sorts the results alphanumerically by the Japanese name of the games.
    
    Returns:
    
    this GamesRequest builder
  - sortByAbbreviation
```
public GamesRequest sortByAbbreviation()
```
    Sorts the results alphanumerically by the abbreviation of the games.
    
    Returns:
    
    this GamesRequest builder
  - sortByReleaseDate
```
public GamesRequest sortByReleaseDate()
```
    Sorts the results by the release date of the games.
    
    Returns:
    
    this GamesRequest builder
  - sortByCreationDate
```
public GamesRequest sortByCreationDate()
```
    Sorts the results by the creation date of the games on SRC.
    
    Returns:
    
    this GamesRequest builder
  - sortByNameSimilarity
```
public GamesRequest sortByNameSimilarity()
```
    Sorts the results by similarity when name(String) is set.
    
    Returns:
    
    this GamesRequest builder
  - sortDirection
```
public GamesRequest sortDirection(SortDirection direction)
```
    Sets the direction (ascending or descending) of the sorting.
    
    Parameters:
    
    direction - the sort direction
    
    Returns:
    
    this GamesRequest builder

Class GamesRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest

Methods inherited from class java.lang.Object

Field Detail

MAX_ITEMS_BULK

Constructor Detail

GamesRequest

Method Detail

name

abbreviation

releaseYear

gameType

gameType

platform

platform

region

region

genre

genre

engine

engine

developer

developer

publisher

publisher

moderator

moderator

asBulk

sortByInternationalName

sortByJapaneseName

sortByAbbreviation

sortByReleaseDate

sortByCreationDate

sortByNameSimilarity

sortDirection