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
`void`	`addAggregateRowDefinition(LinkedHashMap<String,AggregateFunction> aggregateRowDefinition)` Only for internal use.
`void`	`addAllMetaPrimitiveNames(List<String> names)` Only for internal use.
`void`	`addMetaAssociationSchema(IMetaAssociationSchema metaAssociationSchema)` Only for internal use.
`void`	`addMetaPrimitiveName(String name)` Only for internal use.
`void`	`addMetaPrimitiveNames(String... name)` Only for internal use.
`ISortExpression`	`addSortExpression(String memberName, ISortExpression.SortDirection sortDirection)` Adds a new sort expression to this request based on the given parameters.
`void`	`addSortExpressions(ISortExpression... sortExpressions)` Adds all tuples in the Map sort as SortExpressions to this request
`void`	`clearMetaPrimitiveNames()` Only for internal use.
`void`	`clearSortExpressions()` Removes all sort expressions from the list of sort expressions of this request.
`void`	`copyFrom(IRetrievalSchema source)` Copy the immutable parts of the retrieval schema from source.
`List<LinkedHashMap<String,AggregateFunction>>`	`getAggregateRowDefinitions()` Only for internal use.
`long`	`getAmount()` Returns the count of the result rows to be retrieved.
`int`	`getAssociationDepth()` Gets the depth level of the associations.
`List<? extends IMetaAssociationSchema>`	`getMetaAssociationSchemas()` Only for internal use.
`String`	`getMetaObjectName()` Only for internal use.
`List<IMetaObject>`	`getMetaObjects()` Only for internal use.
`Collection<String>`	`getMetaPrimitiveNames()` Only for internal use.
`long`	`getOffset()` Returns the start row from where the result will be retrieved.
`List<? extends ISortExpression>`	`getSortExpressions()` Returns the sort expressions which are used to sort the result data of this request.
`boolean`	`isDistinct()` Only for internal use.
`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`	`setAssociationDepth(int depth)` Sets the depth level of the associations.
`void`	`setDistinct(boolean distinct)` Only for internal use.
`void`	`setMetaObjectName(String name)` Only for internal use.
`void`	`setOffset(long offset)` Sets the start row from where the result will be retrieved.
`boolean`	`useOnlyDeclaredMembers()` Only for internal use.

- 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
```
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 tuples in the Map sort as SortExpressions to this request
    
    Parameters:
    
    sortExpressions - the sort expressions.
  - addSortExpression
```
ISortExpression addSortExpression(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.
  - getAssociationDepth
```
int getAssociationDepth()
```
    Gets the depth level of the associations. When depth is set to 1, associated objects will also be retrieved with the main objects which are retrieved by the query.
  - setAssociationDepth
```
void setAssociationDepth(int depth)
```
    Sets the depth level of the associations. When depth is set to 1, associated objects will also be retrieved with the main objects which are retrieved by the query.
  - useOnlyDeclaredMembers
```
boolean useOnlyDeclaredMembers()
```
    Only for internal use.
  - getMetaObjects
```
List<IMetaObject> getMetaObjects()
```
    Only for internal use.
  - getMetaAssociationSchemas
```
List<? extends IMetaAssociationSchema> getMetaAssociationSchemas()
```
    Only for internal use.
  - addMetaAssociationSchema
```
void addMetaAssociationSchema(IMetaAssociationSchema metaAssociationSchema)
```
    Only for internal use.
    
    Parameters:
    
    metaAssociationSchema -
  - getMetaPrimitiveNames
```
Collection<String> getMetaPrimitiveNames()
```
    Only for internal use.
  - addMetaPrimitiveName
```
void addMetaPrimitiveName(String name)
```
    Only for internal use.
    
    Parameters:
    
    name -
  - addMetaPrimitiveNames
```
void addMetaPrimitiveNames(String... name)
```
    Only for internal use.
    
    Parameters:
    
    name -
  - addAllMetaPrimitiveNames
```
void addAllMetaPrimitiveNames(List<String> names)
```
    Only for internal use.
    
    Parameters:
    
    names -
  - clearMetaPrimitiveNames
```
void clearMetaPrimitiveNames()
```
    Only for internal use.
  - addAggregateRowDefinition
```
void addAggregateRowDefinition(LinkedHashMap<String,AggregateFunction> aggregateRowDefinition)
```
    Only for internal use.
    
    Parameters:
    
    aggregateRowDefinition -
  - getAggregateRowDefinitions
```
List<LinkedHashMap<String,AggregateFunction>> getAggregateRowDefinitions()
```
    Only for internal use.
  - getMetaObjectName
```
String getMetaObjectName()
```
    Only for internal use.
  - setMetaObjectName
```
void setMetaObjectName(String name)
```
    Only for internal use.
    
    Parameters:
    
    name -
  - isDistinct
```
boolean isDistinct()
```
    Only for internal use.
  - setDistinct
```
void setDistinct(boolean distinct)
```
    Only for internal use.
    
    Parameters:
    
    distinct -
  - copyFrom
```
void copyFrom(IRetrievalSchema source)
```
    Copy the immutable parts of the retrieval schema from source.
    
    Parameters:
    
    source -

Interface IRetrievalSchema

Method Summary

Method Detail

getOffset

setOffset

getAmount

setAmount

getSortExpressions

addSortExpressions

addSortExpression

removeSortExpression

clearSortExpressions

getAssociationDepth

setAssociationDepth

useOnlyDeclaredMembers

getMetaObjects

getMetaAssociationSchemas

addMetaAssociationSchema

getMetaPrimitiveNames

addMetaPrimitiveName

addMetaPrimitiveNames

addAllMetaPrimitiveNames

clearMetaPrimitiveNames

addAggregateRowDefinition

getAggregateRowDefinitions

getMetaObjectName

setMetaObjectName

isDistinct

setDistinct

copyFrom