Interface IParameterDefn

All Superinterfaces:
IParameterDefnBase
All Known Subinterfaces:
IDynamicFilterParameterDefn, IScalarParameterDefn

public interface IParameterDefn extends IParameterDefnBase
base interface for a BIRT report parameter
  • Field Details

  • Method Details

    • isHidden

      boolean isHidden()
      returns whether the parameter is a hidden parameter
      Returns:
      whether the parameter is a hidden parameter
    • isRequired

      boolean isRequired()
      Returns:
      whether the parameter is required.
      the rule for String type is:
    • isRequired=true, allowNull and allowBlank are false
    • isRequired=false, allowNull and allowBlank are true

    • for other type like integer:
    • isRequired=true, allowNull and allowBlank are false
    • isRequired=false, allowNull and allowBlank are true
    • getDataType

      int getDataType()
      returns the parameter data type. The valid data type could be IParameterDefn.TYPE_ANY, IParameterDefn.TYPE_STRING, IParameterDefn.TYPE_FLOAT, IParameterDefn.TYPE_DECIMAL, IParameterDefn.TYPE_DATE_TIME, IParameterDefn.TYPE_BOOLEAN, IParameterDefn.TYPE_INTEGER, IParameterDefn.TYPE_DATE, IParameterDefn.TYPE_TIME.
      Returns:
      the parameter data type
    • getSelectionList

      @Deprecated ArrayList getSelectionList()
      Deprecated.
      Returns:
      get a parameter value selection object, from which a list of parameter values and label values can be retrieved.
    • getSelectionListType

      int getSelectionListType()
      Returns:
      the type of the parameter selection list