Package nl.gx.forms.wmpformapi.api.logic

Interface Parameter

    • Method Detail

      • setParameterDefinition

        void setParameterDefinition​(ParameterDefinition parameterDefinition)
        Sets the ParameterDefinition for this Parameter.
        Parameters:
        parameterDefinition - the ParameterDefinition

      • setValue

        void setValue​(String value)
        Returns the value for this Parameter. This property is used for parameters of type Boolean, String, Page, FormFragment and for when the parameter type has been overridden; in the latter case, the value is a JavaScript expression. When the parameter is of type FormFragment, the identifier relative to the root, the identifier relative to the FormVersion is stored (e.g. formstepidentifier.formfragmentidentifier).
        Parameters:
        value - the value for this Parameter

      • setFormStep

        void setFormStep​(FormStep formStep)
        Sets the form step for this Parameter. This property is used for parameters of type Form Step.
        Parameters:
        formStep - the form step for this Parameter

      • setLanguageLabel

        void setLanguageLabel​(LanguageLabel languageLabel)
        Sets the language label for this Parameter. This property is used for parameters of type Language Label.
        Parameters:
        languageLabel - the language label for this Parameter

      • setExpression

        void setExpression​(String expression)
        Sets the expression that should be evaluated to determine the value of this parameter.
        Parameters:
        expression - the expression that should be evaluated to determine the value of this parameter

      • setFragment

        void setFragment​(String fragment)
        Sets the fragment that is the value of this parameter in case the ParameterType indicates it is of type Fragment.
        Parameters:
        fragment - the fragment to assign to this parameter

      • setParameterMode

        void setParameterMode​(ParameterMode mode)
        Sets the mode in which to determine the eventual value of this parameter.
        Parameters:
        mode - the mode in which to determine the eventual value of this parameter

      • setTextValue

        void setTextValue​(String textValue)
        Sets the text value for this Parameter. This property is used for parameters of type Text.
        Parameters:
        textValue - the text value for this Parameter

      • getLanguageContainers

        List<FormLanguageLabelContainer> getLanguageContainers()
        Returns the language label containers that hold translations of specific properties of this form fragment.
        Returns:
        the language label containers that hold translations of specific properties

      • setLanguageContainers

        void setLanguageContainers​(List<FormLanguageLabelContainer> containers)
        Sets the language label containers that hold translations of specific properties of this form fragment.
        Parameters:
        containers - the language label containers that hold translations of specific properties

      • getOrCreateLanguageContainer

        FormLanguageLabelContainer getOrCreateLanguageContainer​(String locale)
        Returns or creates a language label container for a specific locale
        Parameters:
        locale - the locale for which to return the language label container
        Returns:
        the language label container for the specified locale

      • setHidden

        void setHidden​(boolean hidden)
        Sets the hidden flag of this parameter. A hidden parameter is hidden for the editor, but will nevertheless be available for the FormLogicComponent.
        Parameters:
        hidden - the boolean value to set the hidden flag

      • isHidden

        boolean isHidden()
        Returns the hidden flag.
        Returns:
        true if this parameter is hidden

      • setReadOnly

        void setReadOnly​(boolean readOnly)
        Sets the readOnly flag of this parameter. A readOnly parameter is readOnly for the editor, but will nevertheless be available for the FormLogicComponent.
        Parameters:
        readOnly - the boolean value to set the readOnly flag

      • isReadOnly

        boolean isReadOnly()
        Returns the readOnly flag.
        Returns:
        true if this parameter is readOnly