Module org.mule.runtime.extensions.api
Package org.mule.runtime.extension.api.dsql

Interface QueryBuilder

public interface QueryBuilder
Builder interface to create basic query objects.
Since:
1.0

  • Method Details

    • setType

      QueryBuilder setType(EntityType type)
      Sets the queried entity exposed by the application.
      Parameters:
      type - the queried entity type.
      Returns:
      this QueryBuilder instance.

    • addField

      QueryBuilder addField(Field field)
      Sets one of the selected fields from the queried entity.
      Parameters:
      field - a selected field from the queried entity
      Returns:
      this QueryBuilder instance.

    • addOrderByField

      QueryBuilder addOrderByField(Field field)
      Sets one of the fields to order by from.
      Parameters:
      field - a field used to sort the query.
      Returns:
      this QueryBuilder instance.

    • setDirection

      QueryBuilder setDirection(Direction direction)
      Sets the sorting direction of the query.
      Parameters:
      direction - the sorting direction, ASCENDING or DESCENDING.
      Returns:
      this QueryBuilder instance.

    • setFilterExpression

      QueryBuilder setFilterExpression(Expression expression)
      Sets an expression to filter the returned query elements.
      Parameters:
      expression - a filter expression.
      Returns:
      this QueryBuilder instance.

    • setLimit

      QueryBuilder setLimit(int limit)
      Sets the maximum results that can be retrieved by the builded query.
      Parameters:
      limit - the number of max results that can be retrieved by the query.
      Returns:
      this QueryBuilder instance.

    • setOffset

      QueryBuilder setOffset(int offset)
      Sets the number of items to skip from the beginning of the result set.
      Parameters:
      offset - the number of items to skip from the beginning of the result.
      Returns:
      this QueryBuilder instance.

    • build

      DsqlQuery build()
      Returns the final builded DsqlQuery.
      Returns:
      a DsqlQuery instance.