Annotation Type FilterDef

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      The name of the declared filter.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String defaultCondition
      The default filter condition, a SQL expression used for filtering the rows returned by a query when the filter is enabled.
      ParamDef[] parameters
      The names and types of the parameters of the filter.
    • Element Detail

      • name

        String name
        The name of the declared filter.
      • defaultCondition

        String defaultCondition
        The default filter condition, a SQL expression used for filtering the rows returned by a query when the filter is enabled. This default condition may be overridden by any entity or collection to which the filter applies using Filter.condition().

        If every entity and collection to which the filter applies explicitly specifies its own filter condition, then the default condition is unnecessary, and so this member is optional.

        Default:
        ""
      • parameters

        ParamDef[] parameters
        The names and types of the parameters of the filter.
        Default:
        {}