GameCategoriesRequest (Spedran 1.0.2 API)

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

public class GameCategoriesRequest
extends ResourceCollectionRequest<Category>

A request builder to get all Categorys of a given Game.

Constructor Summary

Constructors
Constructor Description

GameCategoriesRequest(Game game)

GameCategoriesRequest(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GameCategoriesRequest`	`miscellaneous(boolean includeMiscellaneous)`	Sets whether miscellaneous categories should be returned.
`GameCategoriesRequest`	`sortByMiscellaneous()`	Sorts the returned categories by the miscellaneous flag.
`GameCategoriesRequest`	`sortByName()`	Sorts the returned categories alphanumerically by name.
`GameCategoriesRequest`	`sortByPosition()`	Sorts the returned categories by the moderator defined position.
`GameCategoriesRequest`	`sortDirection(SortDirection direction)`	Sets the direction to sort the returned categories.

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
  - GameCategoriesRequest
```
public GameCategoriesRequest(String id)
```
  - GameCategoriesRequest
```
public GameCategoriesRequest(Game game)
```
- Method Detail
  - miscellaneous
```
public GameCategoriesRequest miscellaneous(boolean includeMiscellaneous)
```
    Sets whether miscellaneous categories should be returned.
    Defaults to true.
    
    Parameters:
    
    includeMiscellaneous - whether to include miscellaneous categories in the results
    
    Returns:
    
    this object
  - sortByName
```
public GameCategoriesRequest sortByName()
```
    Sorts the returned categories alphanumerically by name.
    
    Returns:
    
    this object
    
    See Also:
    
    IdentifiableNamedResource.getName()
  - sortByMiscellaneous
```
public GameCategoriesRequest sortByMiscellaneous()
```
    Sorts the returned categories by the miscellaneous flag.
    
    Returns:
    
    this object
    
    See Also:
    
    Category.isMiscellaneous()
  - sortByPosition
```
public GameCategoriesRequest sortByPosition()
```
    Sorts the returned categories by the moderator defined position.
    
    Returns:
    
    this object
  - sortDirection
```
public GameCategoriesRequest sortDirection(SortDirection direction)
```
    Sets the direction to sort the returned categories.
    
    Parameters:
    
    direction - the direction to sort, either ascending or descending
    
    Returns:
    
    this object