LevelVariablesRequest (Spedran 1.0.2 API)

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

public class LevelVariablesRequest
extends ResourceCollectionRequest<Variable>

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

Constructor Summary

Constructors
Constructor Description

LevelVariablesRequest(Level level)

LevelVariablesRequest(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LevelVariablesRequest`	`sortByMandatory()`	Sorts the variables by the `Variable.isMandatory()` boolean flag.
`LevelVariablesRequest`	`sortByName()`	Sorts the variables alphanumerically by the variable name.
`LevelVariablesRequest`	`sortByPosition()`	Sorts the variables by the moderator defined position.
`LevelVariablesRequest`	`sortByUserDefined()`	Sorts the variables by the `Variable.isUserDefined()` boolean flag.
`LevelVariablesRequest`	`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
  - LevelVariablesRequest
```
public LevelVariablesRequest(String id)
```
  - LevelVariablesRequest
```
public LevelVariablesRequest(Level level)
```
- Method Detail
  - sortByName
```
public LevelVariablesRequest sortByName()
```
    Sorts the variables alphanumerically by the variable name.
    
    Returns:
    
    this LevelVariablesRequest builder
  - sortByMandatory
```
public LevelVariablesRequest sortByMandatory()
```
    Sorts the variables by the Variable.isMandatory() boolean flag.
    
    Returns:
    
    this LevelVariablesRequest builder
  - sortByUserDefined
```
public LevelVariablesRequest sortByUserDefined()
```
    Sorts the variables by the Variable.isUserDefined() boolean flag.
    
    Returns:
    
    this LevelVariablesRequest builder
  - sortByPosition
```
public LevelVariablesRequest sortByPosition()
```
    Sorts the variables by the moderator defined position.
    
    Returns:
    
    this LevelVariablesRequest builder
  - sortDirection
```
public LevelVariablesRequest sortDirection(SortDirection direction)
```
    Sets the direction (ascending or descending) of the sorting.
    
    Parameters:
    
    direction - the sort direction
    
    Returns:
    
    this LevelVariablesRequest builder