com.mendix.datastorage

Interface XPathSchemaQuery

All Superinterfaces:

XPathQueryBase

public interface XPathSchemaQuery
extends XPathQueryBase

Method Summary

Modifier and Type	Method and Description
XPathSchemaQuery	setDisableSecurity(boolean disable)
XPathSchemaQuery	setRetrievalSchema(IRetrievalSchema schema) Adds a retrieval schema to the query
XPathSchemaQuery	setShouldRetrieveCount(boolean shouldRetrieveCount)
XPathSchemaQuery	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.
XPathSchemaQuery	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.
XPathSchemaQuery	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.
XPathSchemaQuery	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.
XPathSchemaQuery	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.
XPathSchemaQuery	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.
XPathSchemaQuery	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.
XPathSchemaQuery	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

setRetrievalSchema

XPathSchemaQuery setRetrievalSchema(IRetrievalSchema schema)

Adds a retrieval schema to the query

Parameters:

schema - the schema to apply.

Returns:

the instance of XPathSchemaQuery that can be use to construct an XPath query with schema

setDisableSecurity

XPathSchemaQuery setDisableSecurity(boolean disable)

Parameters:

disable - whether security should be applied for this retrieval.

Returns:

the instance of XPathSchemaQuery that can be use to construct an XPath query with schema

setShouldRetrieveCount

XPathSchemaQuery setShouldRetrieveCount(boolean shouldRetrieveCount)

Parameters:

shouldRetrieveCount - indicates whether the total number object corresponding to the given schema should be included in the result.

Returns:

the instance of XPathSchemaQuery that can be use to construct an XPath query with schema

setVariable

XPathSchemaQuery 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

XPathSchemaQuery 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

XPathSchemaQuery 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

XPathSchemaQuery 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

XPathSchemaQuery 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

XPathSchemaQuery 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

XPathSchemaQuery 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

XPathSchemaQuery 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