Package nl.gx.forms.wmpformapi.api

Interface BasicParameter

  • All Known Subinterfaces:
    Parameter, ParameterReference
    All Known Implementing Classes:
    SimpleParameter
    public interface BasicParameter
    Basic interface for a parameter for a FormLogicComponent. All implementations of parameters should implement this interface. A parameter can have one of several modes which determine, together with the type property specified in the ParameterDefinition, what type of value is involved. The ParameterMode property determines the mode used.
    See Also:
    ParameterMode#getType()

    • Method Detail

      • getParameterDefinition

        ParameterDefinition getParameterDefinition()
        Returns the ParameterDefinition for this Parameter.
        Returns:
        the ParameterDefinition which describes this parameter.

      • getValue

        String getValue()
        Returns the value for this Parameter. This property is used for parameters of type String, Textarea, Page, FormFragment and for when the parameter type has been overridden; in the latter case, the value is a JavaScript expression.
        Returns:
        value for this Parameter
        See Also:
        ParameterMode#getType()

      • getTextValue

        String getTextValue()
        Returns the text value for this Parameter. This property is used for parameters of type Text. It returns the text value in a language context.
        Returns:
        value for this Parameter
        See Also:
        ParameterMode#getType()

      • getFormStep

        FormStep getFormStep()
        Returns the FormStep for this Parameter. This property is used for parameters of type FormStep.
        Returns:
        the form step for this Parameter

      • getLanguageLabel

        LanguageLabel getLanguageLabel()
        Returns the language label for this Parameter. This property is used for parameters of type Language Label.
        Returns:
        the language label for this parameter

      • getExpression

        String getExpression()
        Returns the JavaScript expression that returns the value for this Parameter.
        Returns:
        the JavaScript expression that returns the value for this Parameter

      • getFragment

        String getFragment()
        Returns the fragment identifier or value for this Parameter. When the parameter is of type FormFragment identifier, the identifier relative to the FormVersion is stored (e.g. formstepidentifier.formfragmentidentifier). This method is only valid if this parameter is of type fragment.
        Returns:
        the fragment value for this parameter

      • getParameterMode

        ParameterMode getParameterMode()
        Returns the mode for this Parameter.
        Returns:
        the mode for this Parameter
        See Also:
        ParameterMode