Package lumis.service.formbuilder

Class FormField

  • public class FormField
extends java.lang.Object
    Form Builder fields
    Since:
    8.2.0

    • Field Detail

      • NAMED_QUERY_GET_FIELD_BY_FIELDID_AND_FORM_ID

        public static final java.lang.String NAMED_QUERY_GET_FIELD_BY_FIELDID_AND_FORM_ID
        See Also:
        Constant Field Values

    • Constructor Detail

      • FormField

        public FormField()

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the FormField identifier.
        Returns:
        the identifier
        Since:
        8.2.0

      • setId

        public void setId​(java.lang.String id)
        Sets the FormField identifier.
        Parameters:
        id - the identifier value to set.
        Since:
        8.2.0

      • getFormId

        public java.lang.String getFormId()
        Returns the Form this FormField belongs to.
        Returns:
        the Form
        Since:
        8.2.0

      • setFormId

        public void setFormId​(java.lang.String form)
        Sets the Form this FormField belongs to.
        Parameters:
        form - the Form
        Since:
        8.2.0

      • getPosition

        public int getPosition()
        Returns the display position of the FormField.
        Returns:
        the position
        Since:
        8.2.0

      • setPosition

        public void setPosition​(int position)
        Sets the display position of the FormField.
        Parameters:
        position - the position value to set.
        Since:
        8.2.0

      • isRequired

        public boolean isRequired()
        Returns if the user is required to answer the FormField.
        Returns:
        the required
        Since:
        8.2.0

      • setRequired

        public void setRequired​(boolean required)
        Sets if the user is required to answer the FormField.
        Parameters:
        required - the required value to set.
        Since:
        8.2.0

      • getTitle

        public java.lang.String getTitle()
        Returns the title.
        Returns:
        the title
        Since:
        8.2.0

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title.
        Parameters:
        title - the title value to set.
        Since:
        8.2.0

      • getFieldId

        public java.lang.String getFieldId()
        Returns the field identifier.
        Returns:
        the field identifier
        Since:
        8.2.0

      • setFieldId

        public void setFieldId​(java.lang.String fieldId)
        Sets the field identifier.
        Parameters:
        fieldId - the field identifier value to set.
        Since:
        8.2.0

      • getType

        public FormFieldType getType()
        Returns the type.
        Returns:
        the type
        Since:
        8.2.0

      • setType

        public void setType​(FormFieldType type)
        Sets the type.
        Parameters:
        type - the type value to set.
        Since:
        8.2.0

      • getOptions

        public java.util.List<lumis.service.formbuilder.FormFieldOption> getOptions()
        Returns the options for this field.

        The returned list is detached from this entity and any modification on it will not be applied automatically. To modify the options of this field use setOptions(List).

        Returns:
        the options for this field, or null if this field has no option.
        Since:
        9.0.0

      • setOptions

        public void setOptions​(java.util.List<lumis.service.formbuilder.FormFieldOption> options)

      • getHelpText

        public java.lang.String getHelpText()
        Returns the help text.
        Returns:
        the help text.
        Since:
        11.2.0

      • setHelpText

        public void setHelpText​(java.lang.String helpText)
        Sets the help text
        Parameters:
        helpText - the help text to set
        Since:
        11.2.0

      • getAdditionalText

        public java.lang.String getAdditionalText()
        Returns the additional text
        Returns:
        the additional text
        Since:
        11.2.0

      • setAdditionalText

        public void setAdditionalText​(java.lang.String additionalText)
        Sets the additional text
        Parameters:
        additionalText - the additional text to set
        Since:
        11.2.0

      • getMaxLength

        public java.lang.Integer getMaxLength()
        Returns the max length
        Returns:
        Since:
        17.0.0

      • setMaxLength

        public void setMaxLength​(java.lang.Integer maxLength)
        Sets the max length
        Parameters:
        maxLength - the max length allowed in characters
        Since:
        17.0.0

      • getHeadingText

        public java.lang.String getHeadingText()
        Returns the heading text.
        Returns:
        Since:
        17.0.0

      • setHeadingText

        public void setHeadingText​(java.lang.String headingText)
        Sets Heading Text.
        Parameters:
        headingText - the text.
        Since:
        17.0.0

      • getHeadingLevel

        public java.lang.Integer getHeadingLevel()
        Returns the level that Heading will be shown.
        Returns:
        Since:
        17.0.0

      • setHeadingLevel

        public void setHeadingLevel​(java.lang.Integer headingLevel)
        Sets the Heading level.
        Parameters:
        headingLevel - the exhibition level.
        Since:
        17.0.0

      • getValidationRegexp

        public java.lang.String getValidationRegexp()
        Returns the regexp for short text validation.
        Returns:
        the short text.
        Since:
        17.1.0

      • setValidationRegexp

        public void setValidationRegexp​(java.lang.String validationRegexp)
        Sets the regexp for validation.
        Parameters:
        validationRegexp - the regexp string.
        Since:
        17.1.0

      • getValidationErrorMsg

        public java.lang.String getValidationErrorMsg()
        Returns the validation error message.
        Returns:
        the validation message.
        Since:
        17.1.0

      • setValidationErrorMsg

        public void setValidationErrorMsg​(java.lang.String validationErrorMsg)
        Sets the validation error message.
        Parameters:
        validationErrorMsg - the message to be shown when input is not valid.
        Since:
        17.1.0

      • getPlaceholder

        public java.lang.String getPlaceholder()
        Returns fields placeholder for text fields.
        Returns:
        Since:
        17.1.0

      • setPlaceholder

        public void setPlaceholder​(java.lang.String placeholder)
        Sets fields text placeholder.
        Parameters:
        placeholder - the field placeholder.
        Since:
        17.1.0

      • getRequiredErrorMessage

        public java.lang.String getRequiredErrorMessage()
        Returns the error message to be displayed if this field is required and a value is not provided.
        Returns:
        the required error message.
        Since:
        17.1.0

      • setRequiredErrorMessage

        public void setRequiredErrorMessage​(java.lang.String requiredErrorMessage)
        Sets the error message to be displayed if this field is required and a value is not provided.
        Parameters:
        requiredErrorMessage - the required error message.
        Since:
        17.1.0