Package com.mendix.datastorage

Interface XPathSchemaQuery

All Superinterfaces:
XPathQueryBase
public interface XPathSchemaQuery extends XPathQueryBase
Provides an interface to XPath queries that use a retrieval schema.

A retrieval schema provides a way to set the offset, amount, depth and sorting through the IRetrievalSchema interface and is an alternative to setting these parameters directly using XPathBasicQuery.

  • Method Details

    • setRetrievalSchema

      XPathSchemaQuery setRetrievalSchema(IRetrievalSchema schema)
      Adds a retrieval schema to this query. The schema defines paging and sorting on the query.
      Parameters:
      schema - the schema to apply
      Returns:
      the updated query instance

    • setDisableSecurity

      XPathSchemaQuery setDisableSecurity(boolean disable)
      Determines whether security should be applied for this retrieval.
      Parameters:
      disable - true to disable security checks, false to enable security checks
      Returns:
      the updated query instance

    • setShouldRetrieveCount

      XPathSchemaQuery setShouldRetrieveCount(boolean shouldRetrieveCount)
      Determines whether the total number of objects corresponding to this schema should be included in the result.
      Parameters:
      shouldRetrieveCount - true to include the number of corresponding objects, false otherwise
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, BigDecimal value)
      Sets a variable with a value of type BigDecimal.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      value - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, boolean value)
      Sets a variable with a value of type boolean.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      value - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, double value)
      Sets a variable with a value of type double.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      value - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, int value)
      Sets a variable with a value of type int.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      value - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, long value)
      Sets a variable with a value of type long.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      value - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, IMendixObject object)
      Sets a variable with a value of type IMendixObject.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      object - a IMendixObject value. Will be replaced by its IMendixIdentifier in the query.
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, IMendixIdentifier identifier)
      Sets a variable with a value of type IMendixIdentifier.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      identifier - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, String value)
      Sets a variable with a value of type String.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      value - the value of the variable
      Returns:
      the updated query instance

    • setVariable

      XPathSchemaQuery setVariable(String name, Collection<?> values)
      Sets a variable with a value of type Collection.
      Specified by:
      setVariable in interface XPathQueryBase
      Parameters:
      name - name of the variable referenced in the expression (without '$')
      values - the value of the variable as a collection
      Returns:
      the updated query instance

    • allowMathOperators

      XPathSchemaQuery allowMathOperators(boolean allowMathOperators)
      Enable or disable mathematical operators in the XPath query. By default, mathematical operators are not allowed.
      Specified by:
      allowMathOperators in interface XPathQueryBase
      Parameters:
      allowMathOperators - sets whether mathematical operators should be allowed in the XPath query
      Returns:
      the updated query instance