LevelCategoriesRequest (Spedran 1.0.2 API)

java.lang.Object
- com.treescrub.spedran.ResourceCollectionRequest<Category>
- - com.treescrub.spedran.requests.builders.LevelCategoriesRequest

public class LevelCategoriesRequest
extends ResourceCollectionRequest<Category>

A request builder to get the possible Categorys for a given Level.

Constructor Summary

Constructors
Constructor Description

LevelCategoriesRequest(Level level)

LevelCategoriesRequest(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LevelCategoriesRequest`	`miscellaneous(boolean includeMiscellaneous)`	Restricts whether miscellaneous categories should be in the results.
`LevelCategoriesRequest`	`sortByMiscellaneous()`	Sorts the results by the miscellaneous boolean flag.
`LevelCategoriesRequest`	`sortByName()`	Sorts the results alphanumerically by the category name.
`LevelCategoriesRequest`	`sortByPosition()`	Sorts the results by the moderator defined category position.
`LevelCategoriesRequest`	`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
  - LevelCategoriesRequest
```
public LevelCategoriesRequest(String id)
```
  - LevelCategoriesRequest
```
public LevelCategoriesRequest(Level level)
```
- Method Detail
  - miscellaneous
```
public LevelCategoriesRequest miscellaneous(boolean includeMiscellaneous)
```
    Restricts whether miscellaneous categories should be in the results.
    
    Parameters:
    
    includeMiscellaneous - true to include miscellaneous categories, otherwise false
    
    Returns:
    
    this LevelCategoriesRequest builder
  - sortByName
```
public LevelCategoriesRequest sortByName()
```
    Sorts the results alphanumerically by the category name.
    
    Returns:
    
    this LevelCategoriesRequest builder
  - sortByMiscellaneous
```
public LevelCategoriesRequest sortByMiscellaneous()
```
    Sorts the results by the miscellaneous boolean flag.
    
    Returns:
    
    this LevelCategoriesRequest builder
  - sortByPosition
```
public LevelCategoriesRequest sortByPosition()
```
    Sorts the results by the moderator defined category position.
    
    Returns:
    
    this LevelCategoriesRequest builder
  - sortDirection
```
public LevelCategoriesRequest sortDirection(SortDirection direction)
```
    Sets the direction (ascending or descending) of the sorting.
    
    Parameters:
    
    direction - the sort direction
    
    Returns:
    
    this UsersRequest builder