CategoryVariablesRequest (Spedran 1.0.2 API)

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

public class CategoryVariablesRequest
extends ResourceCollectionRequest<Variable>

A request builder to get all Variables for a given Category.

Constructor Summary

Constructors
Constructor Description

CategoryVariablesRequest(Category category)

CategoryVariablesRequest(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CategoryVariablesRequest`	`sortByMandatory()`	Sorts the returned variables by mandatory flag.
`CategoryVariablesRequest`	`sortByName()`	Sorts the returned variables alphanumerically by name.
`CategoryVariablesRequest`	`sortByPosition()`	Sorts the returned variables by the moderator defined position.
`CategoryVariablesRequest`	`sortByUserDefined()`	Sorts the returned variables by user defined flag.
`CategoryVariablesRequest`	`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
  - CategoryVariablesRequest
```
public CategoryVariablesRequest(String id)
```
  - CategoryVariablesRequest
```
public CategoryVariablesRequest(Category category)
```
- Method Detail
  - sortByName
```
public CategoryVariablesRequest sortByName()
```
    Sorts the returned variables alphanumerically by name.
    
    Returns:
    
    this object
    
    See Also:
    
    IdentifiableNamedResource.getName()
  - sortByMandatory
```
public CategoryVariablesRequest sortByMandatory()
```
    Sorts the returned variables by mandatory flag.
    
    Returns:
    
    this object
    
    See Also:
    
    Variable.isMandatory()
  - sortByUserDefined
```
public CategoryVariablesRequest sortByUserDefined()
```
    Sorts the returned variables by user defined flag.
    
    Returns:
    
    this object
    
    See Also:
    
    Variable.isUserDefined()
  - sortByPosition
```
public CategoryVariablesRequest sortByPosition()
```
    Sorts the returned variables by the moderator defined position.
    
    Returns:
    
    this object
  - sortDirection
```
public CategoryVariablesRequest sortDirection(SortDirection direction)
```
    Sets the direction (ascending or descending) of the sorting.
    
    Parameters:
    
    direction - the sort direction
    
    Returns:
    
    this UsersRequest builder