Package io.jmix.reports.annotation

Annotation Interface InputParameterDef

@Target(TYPE) @Retention(RUNTIME) @Repeatable(RepeatableInputParameterDef.class) public @interface InputParameterDef
Defines an input parameter - parameter passed from the outside when running a defined report which can be used as conditions in data sets. Additional associated logic can be declared by creating a method annotated with InputParameterDelegate.
Model object is ReportInputParameter.
See Also:

  • Element Details

    • alias

      String alias
      Unique alias used to access parameter in datasets.

    • type

      ParameterType type
      Data type of the parameter.

    • name

      String name
      Human-readable parameter name.
      Use msg:// format if localization is required. Default message group is inferred from the declaration class's package.
      Default:
      ""

    • required

      boolean required
      Whether the parameter is mandatory.
      Default:
      false

    • enumerationClass

      Class<?> enumerationClass
      Enumeration class for ParameterType.ENUMERATION parameters
      Default:
      void.class

    • defaultValue

      String defaultValue
      String representation of the default value that will be used if no other value is selected by the user. Consider using DefaultValueProvider delegate instead for complex types.
      Default:
      ""

    • defaultDateIsCurrent

      boolean defaultDateIsCurrent
      Whether the current timestamp will be used as the default parameter value for ParameterType.DATE, ParameterType.TIME, ParameterType.DATETIME types.
      Default:
      false

    • entity

      EntityParameterDef entity
      Additional parameters for ParameterType.ENTITY and ParameterType.ENTITY_LIST types.
      Default:
      @io.jmix.reports.annotation.EntityParameterDef

    • predefinedTransformationEnabled

      boolean predefinedTransformationEnabled
      Whether predefined transformation should be used for ParameterType.TEXT parameter (it is useful if parameter is used in a query condition for SQL and JPQL data sets).
      Default:
      false

    • predefinedTransformation

      PredefinedTransformation predefinedTransformation
      Type of the predefined ParameterType.TEXT transformation.
      Default:
      CONTAINS

    • hidden

      boolean hidden
      Whether the request for parameter should be hidden from users.
      Default:
      false