Module com.aoapps.dao.api
Package com.aoapps.dao

Interface Report.Parameter

Enclosing interface:
Report
public static interface Report.Parameter
A single parameter sent to the report query.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Report.Parameter.Type
    The supported parameter types.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLabel()
    Gets a display label for this parameter in the user locale.
    String
    getName()
    Gets the name of this parameter.
    Report.Parameter.Type
    getType()
    Gets the type of this parameter.
    Iterable<? extends Object>
    getValidValues()
    Gets the set of valid values or null if the user may enter a value.

  • Method Details

    • getName

      String getName()
      Gets the name of this parameter.

    • getLabel

      String getLabel()
      Gets a display label for this parameter in the user locale.

    • getType

      Report.Parameter.Type getType()
      Gets the type of this parameter.

    • getValidValues

      Iterable<? extends Object> getValidValues() throws SQLException
      Gets the set of valid values or null if the user may enter a value.
      Throws:
      SQLException