Package com.pullreports.model

Interface Subquery

public interface Subquery
A Subquery returns a query which represents the containing TableConfiguration within the Pull Reports Export Report REST API. Subqueries may be dynamically produced at request time by SubqueryProviders.

Since Subqueries may be dynamically created at request time based on request attributes, Subqueries may optionally return a description to describe their behavior with Pull Reports export results.

Schema analog: <subquery>

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<String>
    getDescription()
    Returns an Optional whose value is the subquery description to be output in each export format or the empty Optional.
    default Optional<String>
    getValue()
    Return an Optional whose value is the complete subquery clause to be used within the SQL from statement or the empty Optional.

  • Method Details

    • getDescription

      default Optional<String> getDescription()
      Returns an Optional whose value is the subquery description to be output in each export format or the empty Optional. The default implementation returns the empty Optional.
      Returns:
      an Optional representing the subquery description.

    • getValue

      default Optional<String> getValue()
      Return an Optional whose value is the complete subquery clause to be used within the SQL from statement or the empty Optional.

      If this method returns the empty Optional, the Pull Reports Export Report API will use the value of the parent TableConfiguration's name property to represent the table within the SQL from clause. In this case, Pull Reports will throw an Exception if the parent TableConfiguration's name property is the empty Optional.

      The default implementation returns the empty Optional.

      Returns:
      an Optional representing the subquery clause.