Package io.jmix.reports.entity

Class ReportInputParameter

java.lang.Object
io.jmix.reports.entity.ReportInputParameter
All Implemented Interfaces:
CopyingSystemState<ReportInputParameter>, ReportParameter, ReportParameterWithDefaultValue, Serializable
public class ReportInputParameter extends Object implements ReportParameterWithDefaultValue, CopyingSystemState<ReportInputParameter>
See Also:

  • Field Details

    • id

      protected UUID id

    • report

      protected Report report

    • type

      protected Integer type

    • name

      protected String name

    • localeNames

      protected String localeNames

    • alias

      protected String alias

    • position

      protected Integer position

    • entityMetaClass

      protected String entityMetaClass

    • lookup

      protected Boolean lookup

    • lookupJoin

      protected String lookupJoin

    • lookupWhere

      protected String lookupWhere

    • enumerationClass

      protected String enumerationClass

    • screen

      protected String screen

    • required

      protected Boolean required

    • defaultValue

      protected String defaultValue

    • parameterClassName

      protected String parameterClassName

    • transformationScript

      protected String transformationScript

    • validationScript

      protected String validationScript

    • validationOn

      protected Boolean validationOn

    • predefinedTransformation

      protected Integer predefinedTransformation

    • hidden

      protected Boolean hidden

    • defaultDateIsCurrent

      protected Boolean defaultDateIsCurrent

    • nameMessageKey

      protected String nameMessageKey
      Message key for localized caption. Used by annotated reports.

    • validationDelegate

      protected ParameterValidator<?> validationDelegate

    • transformationDelegate

      protected ParameterTransformer<?> transformationDelegate

    • defaultValueProvider

      protected DefaultValueProvider<?> defaultValueProvider

  • Constructor Details

    • ReportInputParameter

      public ReportInputParameter()

  • Method Details

    • getId

      public UUID getId()

    • setId

      public void setId(UUID id)

    • getReport

      public Report getReport()

    • setReport

      public void setReport(Report report)

    • getType

      public ParameterType getType()

    • setType

      public void setType(ParameterType type)

    • getName

      public String getName()
      Specified by:
      getName in interface ReportParameter
      Returns:
      user friendly name

    • setName

      public void setName(String name)

    • getAlias

      public String getAlias()
      Specified by:
      getAlias in interface ReportParameter
      Returns:
      alias which is used in formatters and data loaders

    • setAlias

      public void setAlias(String alias)

    • getEntityMetaClass

      public String getEntityMetaClass()

    • getLookup

      public Boolean getLookup()

    • setLookup

      public void setLookup(Boolean lookup)

    • getLookupJoin

      public String getLookupJoin()

    • setLookupJoin

      public void setLookupJoin(String lookupJoin)

    • getLookupWhere

      public String getLookupWhere()

    • setLookupWhere

      public void setLookupWhere(String lookupWhere)

    • setEntityMetaClass

      public void setEntityMetaClass(String entityMetaClass)

    • getEnumerationClass

      public String getEnumerationClass()

    • setEnumerationClass

      public void setEnumerationClass(String enumerationClass)

    • getRequired

      public Boolean getRequired()
      Specified by:
      getRequired in interface ReportParameter

    • setRequired

      public void setRequired(Boolean required)

    • getPosition

      public Integer getPosition()

    • setPosition

      public void setPosition(Integer position)

    • getScreen

      public String getScreen()

    • setScreen

      public void setScreen(String screen)

    • getLocaleNames

      public String getLocaleNames()

    • setLocaleNames

      public void setLocaleNames(String localeNames)

    • getInstanceName

      public String getInstanceName(MsgBundleTools msgBundleTools)

    • getParameterClass

      public Class getParameterClass()
      Specified by:
      getParameterClass in interface ReportParameter
      Returns:
      parameter class eg Date or String, etc

    • setParameterClass

      public void setParameterClass(Class parameterClass)

    • getParameterClassName

      public String getParameterClassName()

    • setParameterClassName

      public void setParameterClassName(String parameterClassName)

    • getDefaultValue

      public String getDefaultValue()
      Specified by:
      getDefaultValue in interface ReportParameterWithDefaultValue
      Returns:
      default value of the parameter, if exists

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • getTransformationScript

      public String getTransformationScript()

    • setTransformationScript

      public void setTransformationScript(String transformationScript)

    • getPredefinedTransformation

      public PredefinedTransformation getPredefinedTransformation()

    • setPredefinedTransformation

      public void setPredefinedTransformation(PredefinedTransformation predefinedTransformation)

    • getValidationScript

      public String getValidationScript()

    • setValidationScript

      public void setValidationScript(String validationScript)

    • getValidationOn

      public Boolean getValidationOn()

    • setValidationOn

      public void setValidationOn(Boolean validationOn)

    • getValidationDelegate

      public ParameterValidator<?> getValidationDelegate()

    • setValidationDelegate

      public void setValidationDelegate(ParameterValidator<?> validationDelegate)

    • getHidden

      public Boolean getHidden()

    • setHidden

      public void setHidden(Boolean hidden)

    • getDefaultDateIsCurrent

      public Boolean getDefaultDateIsCurrent()

    • setDefaultDateIsCurrent

      public void setDefaultDateIsCurrent(Boolean defaultDateIsCurrent)

    • getTransformationDelegate

      public ParameterTransformer<?> getTransformationDelegate()

    • setTransformationDelegate

      public void setTransformationDelegate(ParameterTransformer<?> transformationDelegate)

    • getDefaultValueProvider

      public DefaultValueProvider<?> getDefaultValueProvider()
      Specified by:
      getDefaultValueProvider in interface ReportParameterWithDefaultValue
      Returns:
      provider for the default value. If exists, takes precedence over ReportParameterWithDefaultValue.getDefaultValue().

    • setDefaultValueProvider

      public void setDefaultValueProvider(DefaultValueProvider<?> defaultValueProvider)

    • getNameMessageKey

      public String getNameMessageKey()

    • setNameMessageKey

      public void setNameMessageKey(String nameMessageKey)

    • copyFrom

      public void copyFrom(ReportInputParameter source)
      Description copied from interface: CopyingSystemState
      Invoked by the framework when copying the entity instance.
      Specified by:
      copyFrom in interface CopyingSystemState<ReportInputParameter>
      Parameters:
      source - source entity