java.lang.Object
- com.treescrub.spedran.ResourceCollectionRequest<Run>
- - com.treescrub.spedran.requests.builders.run.RunsRequest

public class RunsRequest
extends ResourceCollectionRequest<Run>

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

Constructor Summary

Constructors
Constructor Description

RunsRequest()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RunsRequest`	`category(Category category)`	Restricts the results to runs played in the given `Category`.
`RunsRequest`	`category(String id)`	Restricts the results to runs played in the given `Category`.
`RunsRequest`	`emulated(boolean isEmulated)`	Restricts the results to runs that are on emulators, or runs that are not on an emulator.
`RunsRequest`	`game(Game game)`	Restricts the results to runs in the given `Game`.
`RunsRequest`	`game(String id)`	Restricts the results to runs in the given `Game`.
`RunsRequest`	`guest(Guest guest)`	Restricts the results to runs that the given `Guest` has participated in.
`RunsRequest`	`guest(String name)`	Restricts the results to runs that the given `Guest` has participated in.
`RunsRequest`	`level(Level level)`	Restricts the results to runs played on the given `Level`.
`RunsRequest`	`level(String id)`	Restricts the results to runs played on the given `Level`.
`RunsRequest`	`platform(Platform platform)`	Restricts the results to runs played on the given `Platform`.
`RunsRequest`	`platform(String id)`	Restricts the results to runs played on the given `Platform`.
`RunsRequest`	`region(Region region)`	Restricts the results to runs played on the given `Region`.
`RunsRequest`	`region(String id)`	Restricts the results to runs played on the given `Region`.
`RunsRequest`	`sortByCategory()`	Sorts the results by the creation time of `Category`s.
`RunsRequest`	`sortByDate()`	Sorts the results by the date of the run.
`RunsRequest`	`sortByEmulation()`	Sorts the results by the `RunSystem.isEmulated()` boolean flag.
`RunsRequest`	`sortByGame()`	Sorts the results by the creation time of `Game`s.
`RunsRequest`	`sortByLevel()`	Sorts the results by the creation time of `Level`s.
`RunsRequest`	`sortByPlatform()`	Sorts the results by the creation time of `Platform`s.
`RunsRequest`	`sortByRegion()`	Sorts the results by the creation time of `Region`s.
`RunsRequest`	`sortBySubmissionDate()`	Sorts the results by the submission time of the run.
`RunsRequest`	`sortByVerificationDate()`	Sorts the results by the time that the run was rejected or verified.
`RunsRequest`	`sortByVerificationStatus()`	Sorts the results by the verification status.
`RunsRequest`	`sortDirection(SortDirection direction)`	Sets the direction (ascending or descending) of the sorting.
`RunsRequest`	`status(SubmissionStatus submissionStatus)`	Restricts the results to runs with the provided `SubmissionStatus`.
`RunsRequest`	`user(User user)`	Restricts the results to runs that the given `User` has participated in.
`RunsRequest`	`user(String id)`	Restricts the results to runs that the given `User` has participated in.
`RunsRequest`	`verifier(User user)`	Restricts the results to runs that the given `User` has rejected or verified.
`RunsRequest`	`verifier(String id)`	Restricts the results to runs that the given `User` has rejected or verified.

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
  - RunsRequest
```
public RunsRequest()
```
- Method Detail
  - user
```
public RunsRequest user(String id)
```
    Restricts the results to runs that the given User has participated in.
    
    Parameters:
    
    id - the user ID
    
    Returns:
    
    this RunsRequest builder
  - user
```
public RunsRequest user(User user)
```
    Restricts the results to runs that the given User has participated in.
    
    Parameters:
    
    user - the user
    
    Returns:
    
    this RunsRequest builder
  - guest
```
public RunsRequest guest(String name)
```
    Restricts the results to runs that the given Guest has participated in.
    
    Parameters:
    
    name - the guest's name
    
    Returns:
    
    this RunsRequest builder
  - guest
```
public RunsRequest guest(Guest guest)
```
    Restricts the results to runs that the given Guest has participated in.
    
    Parameters:
    
    guest - the guest
    
    Returns:
    
    this RunsRequest builder
  - verifier
```
public RunsRequest verifier(String id)
```
    Restricts the results to runs that the given User has rejected or verified.
    
    Parameters:
    
    id - the ID of the verifier
    
    Returns:
    
    this RunsRequest builder
  - verifier
```
public RunsRequest verifier(User user)
```
    Restricts the results to runs that the given User has rejected or verified.
    
    Parameters:
    
    user - the verifier
    
    Returns:
    
    this RunsRequest builder
  - game
```
public RunsRequest game(String id)
```
    Restricts the results to runs in the given Game.
    
    Parameters:
    
    id - the game ID
    
    Returns:
    
    this RunsRequest builder
  - game
```
public RunsRequest game(Game game)
```
    Restricts the results to runs in the given Game.
    
    Parameters:
    
    game - the game
    
    Returns:
    
    this RunsRequest builder
  - level
```
public RunsRequest level(String id)
```
    Restricts the results to runs played on the given Level.
    
    Parameters:
    
    id - the level ID
    
    Returns:
    
    this RunsRequest builder
  - level
```
public RunsRequest level(Level level)
```
    Restricts the results to runs played on the given Level.
    
    Parameters:
    
    level - the level
    
    Returns:
    
    this RunsRequest builder
  - category
```
public RunsRequest category(String id)
```
    Restricts the results to runs played in the given Category.
    
    Parameters:
    
    id - the category ID
    
    Returns:
    
    this RunsRequest builder
  - category
```
public RunsRequest category(Category category)
```
    Restricts the results to runs played in the given Category.
    
    Parameters:
    
    category - the category
    
    Returns:
    
    this RunsRequest builder
  - platform
```
public RunsRequest platform(String id)
```
    Restricts the results to runs played on the given Platform.
    
    Parameters:
    
    id - the platform ID
    
    Returns:
    
    this RunsRequest builder
  - platform
```
public RunsRequest platform(Platform platform)
```
    Restricts the results to runs played on the given Platform.
    
    Parameters:
    
    platform - the platform
    
    Returns:
    
    this RunsRequest builder
  - region
```
public RunsRequest region(String id)
```
    Restricts the results to runs played on the given Region.
    
    Parameters:
    
    id - the region ID
    
    Returns:
    
    this RunsRequest builder
  - region
```
public RunsRequest region(Region region)
```
    Restricts the results to runs played on the given Region.
    
    Parameters:
    
    region - the region
    
    Returns:
    
    this RunsRequest builder
  - emulated
```
public RunsRequest emulated(boolean isEmulated)
```
    Restricts the results to runs that are on emulators, or runs that are not on an emulator.
    
    Parameters:
    
    isEmulated - restrict based on emulator used
    
    Returns:
    
    this RunsRequest builder
  - status
```
public RunsRequest status(SubmissionStatus submissionStatus)
```
    Restricts the results to runs with the provided SubmissionStatus.
    
    Parameters:
    
    submissionStatus - the verification status to filter for
    
    Returns:
    
    this RunsRequest builder
  - sortByGame
```
public RunsRequest sortByGame()
```
    Sorts the results by the creation time of Games.
    
    Returns:
    
    this RunsRequest builder
  - sortByCategory
```
public RunsRequest sortByCategory()
```
    Sorts the results by the creation time of Categorys.
    
    Returns:
    
    this RunsRequest builder
  - sortByLevel
```
public RunsRequest sortByLevel()
```
    Sorts the results by the creation time of Levels.
    
    Returns:
    
    this RunsRequest builder
  - sortByPlatform
```
public RunsRequest sortByPlatform()
```
    Sorts the results by the creation time of Platforms.
    
    Returns:
    
    this RunsRequest builder
  - sortByRegion
```
public RunsRequest sortByRegion()
```
    Sorts the results by the creation time of Regions.
    
    Returns:
    
    this RunsRequest builder
  - sortByEmulation
```
public RunsRequest sortByEmulation()
```
    Sorts the results by the RunSystem.isEmulated() boolean flag.
    
    Returns:
    
    this RunsRequest builder
  - sortByDate
```
public RunsRequest sortByDate()
```
    Sorts the results by the date of the run.
    
    Returns:
    
    this RunsRequest builder
  - sortBySubmissionDate
```
public RunsRequest sortBySubmissionDate()
```
    Sorts the results by the submission time of the run.
    
    Returns:
    
    this RunsRequest builder
  - sortByVerificationStatus
```
public RunsRequest sortByVerificationStatus()
```
    Sorts the results by the verification status.
    
    Returns:
    
    this RunsRequest builder
  - sortByVerificationDate
```
public RunsRequest sortByVerificationDate()
```
    Sorts the results by the time that the run was rejected or verified.
    
    Returns:
    
    this RunsRequest builder
  - sortDirection
```
public RunsRequest sortDirection(SortDirection direction)
```
    Sets the direction (ascending or descending) of the sorting.
    
    Parameters:
    
    direction - the sort direction
    
    Returns:
    
    this RunsRequest builder

Class RunsRequest

Constructor Summary

Method Summary

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest

Methods inherited from class java.lang.Object

Constructor Detail

RunsRequest

Method Detail

user

user

guest

guest

verifier

verifier

game

game

level

level

category

category

platform

platform

region

region

emulated

status

sortByGame

sortByCategory

sortByLevel

sortByPlatform

sortByRegion

sortByEmulation

sortByDate

sortBySubmissionDate

sortByVerificationStatus

sortByVerificationDate

sortDirection