com.mendix.systemwideinterfaces.connectionbus.requests

Interface IRetrievalSchema

public interface IRetrievalSchema

Representation of the structure the to be retrieved data should adhere to.

Method Summary

Modifier and Type	Method and Description
void	addAggregateRowDefinition(java.util.LinkedHashMap<java.lang.String,AggregateFunction> aggregateRowDefinition) Deprecated.
void	addAllMetaPrimitiveNames(java.util.List<java.lang.String> names) Deprecated.
void	addMetaAssociationSchema(IMetaAssociationSchema metaAssociationSchema) Deprecated.
void	addMetaPrimitiveName(java.lang.String name) Deprecated.
void	addMetaPrimitiveNames(java.lang.String... name) Deprecated.
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 tuples in the Map sort as SortExpressions to this request
void	clearMetaPrimitiveNames() Deprecated.
void	clearSortExpressions() Removes all sort expressions from the list of sort expressions of this request.
void	copyFrom(IRetrievalSchema source) Deprecated.
java.util.List<java.util.LinkedHashMap<java.lang.String,AggregateFunction>>	getAggregateRowDefinitions() Deprecated.
long	getAmount() Returns the count of the result rows to be retrieved.
int	getAssociationDepth() Deprecated.
java.util.List<? extends IMetaAssociationSchema>	getMetaAssociationSchemas() Deprecated.
java.lang.String	getMetaObjectName() Deprecated.
java.util.List<IMetaObject>	getMetaObjects() Deprecated.
java.util.Collection<java.lang.String>	getMetaPrimitiveNames() Deprecated.
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.
boolean	isDistinct() Deprecated.
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) Deprecated.
void	setDistinct(boolean distinct) Deprecated.
void	setMetaObjectName(java.lang.String name) Deprecated.
void	setOffset(long offset) Sets the start row from where the result will be retrieved.
boolean	useOnlyDeclaredMembers() Deprecated.

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 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.

getAssociationDepth

@Deprecated
int getAssociationDepth()

Deprecated.

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

@Deprecated
void setAssociationDepth(int depth)

Deprecated.

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

@Deprecated
boolean useOnlyDeclaredMembers()

Deprecated.

getMetaObjects

@Deprecated
java.util.List<IMetaObject> getMetaObjects()

Deprecated.

getMetaAssociationSchemas

@Deprecated
java.util.List<? extends IMetaAssociationSchema> getMetaAssociationSchemas()

Deprecated.

addMetaAssociationSchema

@Deprecated
void addMetaAssociationSchema(IMetaAssociationSchema metaAssociationSchema)

Deprecated.

getMetaPrimitiveNames

@Deprecated
java.util.Collection<java.lang.String> getMetaPrimitiveNames()

Deprecated.

addMetaPrimitiveName

@Deprecated
void addMetaPrimitiveName(java.lang.String name)

Deprecated.

addMetaPrimitiveNames

@Deprecated
void addMetaPrimitiveNames(java.lang.String... name)

Deprecated.

addAllMetaPrimitiveNames

@Deprecated
void addAllMetaPrimitiveNames(java.util.List<java.lang.String> names)

Deprecated.

clearMetaPrimitiveNames

@Deprecated
void clearMetaPrimitiveNames()

Deprecated.

addAggregateRowDefinition

@Deprecated
void addAggregateRowDefinition(java.util.LinkedHashMap<java.lang.String,AggregateFunction> aggregateRowDefinition)

Deprecated.

getAggregateRowDefinitions

@Deprecated
java.util.List<java.util.LinkedHashMap<java.lang.String,AggregateFunction>> getAggregateRowDefinitions()

Deprecated.

getMetaObjectName

@Deprecated
java.lang.String getMetaObjectName()

Deprecated.

setMetaObjectName

@Deprecated
void setMetaObjectName(java.lang.String name)

Deprecated.

isDistinct

@Deprecated
boolean isDistinct()

Deprecated.

setDistinct

@Deprecated
void setDistinct(boolean distinct)

Deprecated.

copyFrom

@Deprecated
void copyFrom(IRetrievalSchema source)

Deprecated.

Copy the immutable parts of the retrieval schema from source.

Parameters:

source -