Public Member Functions
void	setOffset (long offset)
long	getAmount ()
void	setAmount (long amount)
int	getFetchSize ()
void	setFetchSize (int fetchSize)
List<?extends ISortExpression >	getSortExpressions ()
void	addSortExpressions (ISortExpression...sortExpressions)
ISortExpression	addSortExpression (String memberName, SortDirection sortDirection)
void	removeSortExpression (ISortExpression sortExpression)
void	clearSortExpressions ()
int	getAssociationDepth ()
void	setAssociationDepth (int depth)
boolean	useOnlyDeclaredMembers ()
List< IMetaObject >	getMetaObjects ()
List<?extends IMetaAssociationSchema >	getMetaAssociationSchemas ()
void	addMetaAssociationSchema (IMetaAssociationSchema metaAssociationSchema)
Collection< String >	getMetaPrimitiveNames ()
void	addMetaPrimitiveName (String name)
void	addMetaPrimitiveNames (String...name)
void	addAllMetaPrimitiveNames (List< String > names)
void	clearMetaPrimitiveNames ()
void	addAggregateRowDefinition (LinkedHashMap< String, AggregateFunction > aggregateRowDefinition)
List< LinkedHashMap< String, AggregateFunction > >	getAggregateRowDefinitions ()
String	getMetaObjectName ()
void	setMetaObjectName (String name)
boolean	isSecurityDisabled ()
void	setSecurityDisabled (boolean securityDisabled)
boolean	isDistinct ()
void	setDistinct (boolean distinct)
Element	toXML (Document xmlDoc)
void	copyFrom (IRetrievalSchema source)
Package Functions
long	getOffset ()

Detailed Description

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

Member Function Documentation

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addAggregateRowDefinition ( LinkedHashMap< String, AggregateFunction > aggregateRowDefinition )

Only for internal use.

Parameters:

aggregateRowDefinition

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addAllMetaPrimitiveNames ( List< String > names )

Only for internal use.

Parameters:

names

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addMetaAssociationSchema ( IMetaAssociationSchema metaAssociationSchema )

Only for internal use.

Parameters:

metaAssociationSchema

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addMetaPrimitiveName ( String name )

Only for internal use.

Parameters:

name

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addMetaPrimitiveNames ( String... name )

Only for internal use.

Parameters:

name

ISortExpression com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addSortExpression	(	String	memberName,
		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

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.addSortExpressions ( ISortExpression... sortExpressions )

Adds all <field,direction> tuples in the Map sort as SortExpressions to this request

Parameters:

sortExpressions the sort expressions.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.clearMetaPrimitiveNames ( )

Only for internal use.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.clearSortExpressions ( )

Removes all sort expressions from the list of sort expressions of this request.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.copyFrom ( IRetrievalSchema source )

Copy the immutable parts of the retrieval schema from source.

Parameters:

source

List<LinkedHashMap<String, AggregateFunction> > com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getAggregateRowDefinitions ( )

Only for internal use.

long com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getAmount ( )

Returns the count of the result rows to be retrieved.

int com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.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.

int com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getFetchSize ( )

Only for internal use.

List<? extends IMetaAssociationSchema> com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getMetaAssociationSchemas ( )

Only for internal use.

String com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getMetaObjectName ( )

Only for internal use.

List<IMetaObject> com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getMetaObjects ( )

Only for internal use.

Collection<String> com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getMetaPrimitiveNames ( )

Only for internal use.

long com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getOffset ( ) [package]

Returns the start row from where the result will be retrieved.

List<? extends ISortExpression> com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.getSortExpressions ( )

Returns the sort expressions which are used to sort the result data of this request.

boolean com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.isDistinct ( )

Only for internal use.

boolean com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.isSecurityDisabled ( )

This method is deprecated. Call GetRequest.isSecurityDisabled().

Returns:

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.removeSortExpression ( ISortExpression sortExpression )

Removes a sort expression from the list of sort expressions of this request.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.setAmount ( long amount )

Sets the count of the result rows to be retrieved.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.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.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.setDistinct ( boolean distinct )

Only for internal use.

Parameters:

distinct

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.setFetchSize ( int fetchSize )

Only for internal use.

Parameters:

fetchSize

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.setMetaObjectName ( String name )

Only for internal use.

Parameters:

name

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.setOffset ( long offset )

Sets the start row from where the result will be retrieved.

void com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.setSecurityDisabled ( boolean securityDisabled )

This method is deprecated. Call GetRequest.setSecurityDisabled().

Parameters:

securityDisabled

Element com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.toXML ( Document xmlDoc )

Only for internal use.

Parameters:

xmlDoc

boolean com.mendix.systemwideinterfaces.connectionbus.requests.IRetrievalSchema.useOnlyDeclaredMembers ( )

Only for internal use.

The documentation for this interface was generated from the following file:

IRetrievalSchema.java

Public Member Functions

Package Functions

Detailed Description

Member Function Documentation