Interface IParameterDefnBase

All Known Subinterfaces:
ICascadingParameterGroup, IDynamicFilterParameterDefn, IParameterDefn, IParameterGroupDefn, IScalarParameterDefn

public interface IParameterDefnBase
Captures properties shared by all types of parameters and parameter group, i.e., name, display name, help text and custom-defined properties. Note that even though display name and help text are locale-sensitive, the API does not take a locale. The parameter returned to the user was obtained from a report runnable, which has already had a locale.
  • Field Details

  • Method Details

    • getParameterType

      int getParameterType()
      Returns:
      the parameter type, i.e., scalar, filter, list, table or parameter group
    • getTypeName

      String getTypeName()
      Returns:
      name of the parameter type.
    • getName

      String getName()
      returns the name of the parameter
      Returns:
      the name of the parameter
    • getDisplayName

      String getDisplayName()
      returns the locale-specific display name for the parameter. The locale used is the locale in the getParameterDefinition task
      Returns:
      display name under the request or default locale
    • getHelpText

      String getHelpText()
      returns the locale-specific help text. The locale used is the locale in the getParameterDefinition task
      Returns:
      help text for the parameter
    • getUserPropertyValues

      Map getUserPropertyValues()
      returns a collection of user-defined property name and value pairs
      Returns:
      a collection of user-defined property name ane value pairs
    • getUserPropertyValue

      String getUserPropertyValue(String name)
      returns the value of a user-defined property
      Returns:
      the value for a user-defined property
    • getHandle

      org.eclipse.birt.report.model.api.ReportElementHandle getHandle()
      returns the report element handle which is wrapped by this object.
      Returns:
      the report element handle
    • getPromptText

      String getPromptText()
      Returns:
      prompt text