Interface RegistrationFieldDisplayHints.Builder

    • Method Detail

      • title

        RegistrationFieldDisplayHints.Builder title​(String title)

        The title of the display hint.

        Parameters:
        title - The title of the display hint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • shortDescription

        RegistrationFieldDisplayHints.Builder shortDescription​(String shortDescription)

        A short description of the display hint.

        Parameters:
        shortDescription - A short description of the display hint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • longDescription

        RegistrationFieldDisplayHints.Builder longDescription​(String longDescription)

        A full description of the display hint.

        Parameters:
        longDescription - A full description of the display hint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • documentationTitle

        RegistrationFieldDisplayHints.Builder documentationTitle​(String documentationTitle)

        The title of the document the display hint is associated with.

        Parameters:
        documentationTitle - The title of the document the display hint is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • documentationLink

        RegistrationFieldDisplayHints.Builder documentationLink​(String documentationLink)

        The link to the document the display hint is associated with.

        Parameters:
        documentationLink - The link to the document the display hint is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • selectOptionDescriptions

        RegistrationFieldDisplayHints.Builder selectOptionDescriptions​(Collection<SelectOptionDescription> selectOptionDescriptions)

        An array of SelectOptionDescription objects.

        Parameters:
        selectOptionDescriptions - An array of SelectOptionDescription objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • selectOptionDescriptions

        RegistrationFieldDisplayHints.Builder selectOptionDescriptions​(SelectOptionDescription... selectOptionDescriptions)

        An array of SelectOptionDescription objects.

        Parameters:
        selectOptionDescriptions - An array of SelectOptionDescription objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • textValidationDescription

        RegistrationFieldDisplayHints.Builder textValidationDescription​(String textValidationDescription)

        The validation rules for the text field.

        Parameters:
        textValidationDescription - The validation rules for the text field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • exampleTextValue

        RegistrationFieldDisplayHints.Builder exampleTextValue​(String exampleTextValue)

        Example text of what the value of a field should contain.

        Parameters:
        exampleTextValue - Example text of what the value of a field should contain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.