GameVariablesRequest (Spedran 1.0.2 API)

java.lang.Object
- com.treescrub.spedran.ResourceCollectionRequest<Variable>
- - com.treescrub.spedran.requests.builders.game.GameVariablesRequest

public class GameVariablesRequest
extends ResourceCollectionRequest<Variable>

A request builder to get all the Variables of a Game.

Constructor Summary

Constructors
Constructor Description

GameVariablesRequest(Game game)

GameVariablesRequest(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GameVariablesRequest`	`sortByMandatory()`	Sorts the variables by the `Variable.isMandatory()` boolean flag.
`GameVariablesRequest`	`sortByName()`	Sorts the variables alphanumerically by the variable name.
`GameVariablesRequest`	`sortByPosition()`	Sorts the variables by the moderator defined position.
`GameVariablesRequest`	`sortByUserDefined()`	Sorts the variables by the `Variable.isUserDefined()` boolean flag.
`GameVariablesRequest`	`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

- Constructor Detail
  - GameVariablesRequest
```
public GameVariablesRequest(String id)
```
  - GameVariablesRequest
```
public GameVariablesRequest(Game game)
```
- Method Detail
  - sortByName
```
public GameVariablesRequest sortByName()
```
    Sorts the variables alphanumerically by the variable name.
    
    Returns:
    
    this GameVariablesRequest builder
  - sortByMandatory
```
public GameVariablesRequest sortByMandatory()
```
    Sorts the variables by the Variable.isMandatory() boolean flag.
    
    Returns:
    
    this GameVariablesRequest builder
  - sortByUserDefined
```
public GameVariablesRequest sortByUserDefined()
```
    Sorts the variables by the Variable.isUserDefined() boolean flag.
    
    Returns:
    
    this GameVariablesRequest builder
  - sortByPosition
```
public GameVariablesRequest sortByPosition()
```
    Sorts the variables by the moderator defined position.
    
    Returns:
    
    this GameVariablesRequest builder
  - sortDirection
```
public GameVariablesRequest sortDirection(SortDirection direction)
```
    Sets the direction (ascending or descending) of the sorting.
    
    Parameters:
    
    direction - the sort direction
    
    Returns:
    
    this GamesRequest builder