Interface ParameterDefinition

  • All Superinterfaces:
    Identifiable

    public interface ParameterDefinition
    extends Identifiable
    Definition of a parameter for a FormLogicComponent.
    • Field Detail

      • PARAMETER_TYPE_STRING

        static final int PARAMETER_TYPE_STRING
        Indicates a parameter is of type String.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_STEP

        static final int PARAMETER_TYPE_STEP
        Indicates a parameter if of type FormStep.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_PAGE

        static final int PARAMETER_TYPE_PAGE
        Indicates a parameter is of type Page.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_LANGUAGE_LABEL

        static final int PARAMETER_TYPE_LANGUAGE_LABEL
        Indicates a parameter is of type LanguageLabel.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_FORMFRAGMENT_IDENTIFIER

        static final int PARAMETER_TYPE_FORMFRAGMENT_IDENTIFIER
        Indicates a parameter is of type FormFragment Identifier.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_FORMFRAGMENT_VALUE

        static final int PARAMETER_TYPE_FORMFRAGMENT_VALUE
        Indicates a parameter is of type FormFragment Value.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_TEXTAREA

        static final int PARAMETER_TYPE_TEXTAREA
        Indicates a parameter is of type Textarea.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_BOOLEAN

        static final int PARAMETER_TYPE_BOOLEAN
        Indicates a parameter is of type Boolean.
        See Also:
        Constant Field Values
      • PARAMETER_TYPE_TEXT

        static final int PARAMETER_TYPE_TEXT
        Indicates a parameter is of type Text (language context specific).
        See Also:
        Constant Field Values
    • Method Detail

      • getIdentifier

        String getIdentifier()
        Returns the identifier for this parameter. This is used to identify the parameter. Also, it is the name of the function parameter to be used in the JavaScript function of the form logic component to which this parameter definition belongs.
        Returns:
        the identifier for this parameter
      • setIdentifier

        void setIdentifier​(String identifier)
        Returns the identifier for this parameter. This is used to identify the parameter. Also, it is the name of function parameter to be used in the JavaScript function of the form logic component to which this parameter definition belongs.
        Parameters:
        identifier - the identifier for this parameter
      • getType

        int getType()
        Returns the type for this parameter. This can be String, Step, Page, Language Label, Form Field Identifier or Form Fragment Value. Use one of the final static members of ParameterDefinition as the value.
        Returns:
        the type of this parameter
      • setType

        void setType​(int type)
        Sets the type for this parameter. This can be String, Step, Page, Language Label, Form Field Identifier or Form Fragment Value. Use one of the final static members of ParameterDefinition as the value.
        Parameters:
        type - the type of this parameter
      • getLanguageLabel

        String getLanguageLabel()
        Returns the language label key for this parameter.
        Returns:
        the language label key for this parameter
      • setLanguageLabel

        void setLanguageLabel​(String languageLabelKey)
        Updates the language label key for this parameter.
        Parameters:
        languageLabelKey - the new language label key for this parameter
      • getTitle

        String getTitle()
        Returns the title of this parameter definition using the default locale of the session.
        Returns:
        the title of this parameter definition using the default locale of the session or null if it could not be found or the locale could not be determined
      • getFormLogicComponentDefinition

        FormLogicComponentDefinition getFormLogicComponentDefinition()
        Returns the form logic component definition to which this parameter definition belongs.
        Returns:
        the form logic component definition to which this parameter definition belongs
      • setFormLogicComponentDefinition

        void setFormLogicComponentDefinition​(FormLogicComponentDefinition formLogicComponentDefinition)
        Sets the form logic component definition to which this parameter definition belongs. Note that this property is not persisted and therefore this method cannot be used to move parameter definitions.
        Parameters:
        formLogicComponentDefinition - the form logic component definition to use for this paramenter.
      • isRequired

        boolean isRequired()
        Returns whether this parameter is required.
        Returns:
        whether this parameter is required
      • setRequired

        void setRequired​(boolean required)
        Sets whether this parameter is required.
        Parameters:
        required - whether this parameter is required
      • getDefaultParameter

        Parameter getDefaultParameter()
        Returns the parameter that contains the default value. This value can be retrieved in case the parameter variant definition is used to create parameter objects of a form logic component.
        Returns:
        the parameter object
      • setDefaultParameter

        void setDefaultParameter​(Parameter parameter)
        Sets the parameter object that contains the default value
        Parameters:
        parameter - the parameter object
      • isHidden

        boolean isHidden()
        Returns if this parameter variant definition is hidden.
        Returns:
        true if this parameter variant definition is hidden.
      • setHidden

        void setHidden​(boolean hidden)
        Sets the hidden property of this parameter variant definition.
        Parameters:
        hidden - the hidden property of this parameter variant definition.
      • isReadOnly

        boolean isReadOnly()
        Returns if this parameter variant definition is readonly.
        Returns:
        true if this parameter variant definition is readonly
      • setReadOnly

        void setReadOnly​(boolean readOnly)
        Sets the readonly property of this parameter variant definition.
        Parameters:
        readOnly - the readonly property of this parameter variant definition.