com.mendix.datastorage

Interface XPathBasicQuery

All Superinterfaces:

XPathQueryBase

All Known Subinterfaces:

XPathQuery

public interface XPathBasicQuery
extends XPathQueryBase

Method Summary

Modifier and Type	Method and Description
XPathBasicQuery	addSort(java.lang.String attribute, boolean ascending) Adds a sort direction.
XPathBasicQuery	setAmount(int amount)
XPathBasicQuery	setDepth(int depth)
XPathBasicQuery	setOffset(int offset)
XPathBasicQuery	setVariable(java.lang.String name, java.math.BigDecimal value) Sets a variable with a value of type BigDecimal Adds a BigDecimal variable In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, boolean value) Sets a variable with a value of type Boolean In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, double value) Sets a variable with a value of type Double In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, IMendixIdentifier identifier) Sets a variable with a value of type IMendixIdentifier In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, IMendixObject object) Sets a variable with a value of type IMendixObject In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, int value) Sets a variable with a value of type Integer In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, long value) Sets a variable with a value of type Long In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.
XPathBasicQuery	setVariable(java.lang.String name, java.lang.String value) Sets a variable with a value of type String In XPath queries it is possible to add variables Variable can be denoted with '$', e.g.

Methods inherited from interface com.mendix.datastorage.XPathQueryBase

execute

Method Detail

setAmount

XPathBasicQuery setAmount(int amount)

Parameters:

amount - the maximum number of objects to retrieve.

Returns:

the instance of XPathBasicQuery that can be use to construct a basic XPath query

setOffset

XPathBasicQuery setOffset(int offset)

Parameters:

offset - the index of the first object to retrieve.

Returns:

the instance of XPathBasicQuery that can be use to construct a basic XPath query

addSort

XPathBasicQuery addSort(java.lang.String attribute,
                        boolean ascending)

Adds a sort direction. This affects the sort of the objects that are retrieved. When multiple sorts are added each subsequent sort objects that are equal according to the earlier values

Parameters:

attribute - the attribute on which should be sorted

ascending - the direction of the sort. If this value is true it sorts from the smallest value to the largest. If it is false it sorts from the largest value to the smallest.

Returns:

the instance of XPathBasicQuery that can be use to construct a basic XPath query

setDepth

XPathBasicQuery setDepth(int depth)

Parameters:

depth - this indicates the level until which each reference (IMendixIdentifier) is also retrieved as an IMendixObject.

Returns:

the instance of XPathBasicQuery that can be use to construct a basic XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            java.math.BigDecimal value)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type BigDecimal Adds a BigDecimal variable In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

value - variable that represents a literal BigDecimal value

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            boolean value)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type Boolean In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

value - variable that represents a literal Boolean value

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            double value)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type Double In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

value - variable that represents a literal Double value

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            int value)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type Integer In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

value - variable that represents a literal Integer value

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            long value)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type Long In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

value - variable that represents a literal Long value

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            IMendixObject object)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type IMendixObject In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

object - variable that represents a IMendixObject value. Will be replaced by it's identifier in the query

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            IMendixIdentifier identifier)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type IMendixIdentifier In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

identifier - variable that represents an identifier of an object

Returns:

the instance of XPathQuery that can be use to construct an XPath query

setVariable

XPathBasicQuery setVariable(java.lang.String name,
                            java.lang.String value)

Description copied from interface: XPathQueryBase

Sets a variable with a value of type String In XPath queries it is possible to add variables Variable can be denoted with '$', e.g. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

Specified by:

setVariable in interface XPathQueryBase

Parameters:

name - name of variables referenced in the expression (without '$') and their values.

value - variable that represents a literal String value

Returns:

the instance of XPathQuery that can be use to construct an XPath query