IRetrievalSchema

```
public interface IRetrievalSchema
```
Representation of the structure the to be retrieved data should adhere to.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ISortExpression`	`addSortExpression(java.lang.String memberName, ISortExpression.SortDirection sortDirection)` Adds a new sort expression to this request based on the given parameters.
`void`	`addSortExpressions(ISortExpression... sortExpressions)` Adds all <field,direction> tuples in the Map sort as SortExpressions to this request
`void`	`clearSortExpressions()` Removes all sort expressions from the list of sort expressions of this request.
`long`	`getAmount()` Returns the count of the result rows to be retrieved.
`long`	`getOffset()` Returns the start row from where the result will be retrieved.
`java.util.List<? extends ISortExpression>`	`getSortExpressions()` Returns the sort expressions which are used to sort the result data of this request.
`void`	`removeSortExpression(ISortExpression sortExpression)` Removes a sort expression from the list of sort expressions of this request.
`void`	`setAmount(long amount)` Sets the count of the result rows to be retrieved.
`void`	`setOffset(long offset)` Sets the start row from where the result will be retrieved.

- Method Detail
  - getOffset
```
long getOffset()
```
    Returns the start row from where the result will be retrieved.
  - setOffset
```
void setOffset(long offset)
```
    Sets the start row from where the result will be retrieved.
  - getAmount
```
long getAmount()
```
    Returns the count of the result rows to be retrieved.
  - setAmount
```
void setAmount(long amount)
```
    Sets the count of the result rows to be retrieved.
  - getSortExpressions
```
java.util.List<? extends ISortExpression> getSortExpressions()
```
    Returns the sort expressions which are used to sort the result data of this request.
  - addSortExpressions
```
void addSortExpressions(ISortExpression... sortExpressions)
```
    Adds all <field,direction> tuples in the Map sort as SortExpressions to this request
    
    Parameters:
    
    sortExpressions - the sort expressions.
  - addSortExpression
```
ISortExpression addSortExpression(java.lang.String memberName,
                                  ISortExpression.SortDirection sortDirection)
```
    Adds a new sort expression to this request based on the given parameters.
    
    Parameters:
    
    memberName - the member on which the query result must be sorted
    
    sortDirection - the sort order
    
    Returns:
    
    the newly created ISortExpression
  - removeSortExpression
```
void removeSortExpression(ISortExpression sortExpression)
```
    Removes a sort expression from the list of sort expressions of this request.
  - clearSortExpressions
```
void clearSortExpressions()
```
    Removes all sort expressions from the list of sort expressions of this request.

Interface IRetrievalSchema

Method Summary

Method Detail

getOffset

setOffset

getAmount

setAmount

getSortExpressions

addSortExpressions

addSortExpression

removeSortExpression

clearSortExpressions