com.mendix.datastorage

Interface XPathQueryBase

All Known Subinterfaces:

XPathBasicQuery, XPathQuery, XPathSchemaQuery

public interface XPathQueryBase

Method Summary

Modifier and Type	Method and Description
java.util.List<IMendixObject>	execute(IContext context) Retrieves object list using the given context (synchronously).
XPathQueryBase	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.
XPathQueryBase	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.
XPathQueryBase	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.
XPathQueryBase	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.
XPathQueryBase	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.
XPathQueryBase	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.
XPathQueryBase	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.
XPathQueryBase	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.

Method Detail

execute

java.util.List<IMendixObject> execute(IContext context)

Retrieves object list using the given context (synchronously).

Parameters:

context - the context to be used to process this request

Returns:

the list of retrieved objects.

setVariable

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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

XPathQueryBase 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. a valid query syntax could be '//Entity.Ref[field >= $limit]'.

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