Package de.xima.fc.user_portal.view_model

Class WelcomePageModel.Builder

  • Enclosing class:
    WelcomePageModel
    public static final class WelcomePageModel.Builder
extends Object
    Builder for configuring an instance of the welcome page model.
    Since:
    8.2.0

    • Method Detail

      • build

        public WelcomePageModel build()
        Builds a new instance of the welcome page model with the configured properties. The builder can be reused after calling this method. The returned instance is immutable.
        Returns:
        A new welcome page model.

      • formsButtonLabel

        public WelcomePageModel.Builder formsButtonLabel​(String formsButtonLabel)
        Sets the display text for the forms button on the welcome page.
        Parameters:
        formsButtonLabel - The forms button text.
        Returns:
        This builder for chaining method calls.

      • labelAccessibility

        public WelcomePageModel.Builder labelAccessibility​(String labelAccessibility)
        Sets the display text for the accessibility page of the user portal.
        Parameters:
        labelAccessibility - The accessibility text.
        Returns:
        This builder for chaining method calls.

      • labelDataPrivacy

        public WelcomePageModel.Builder labelDataPrivacy​(String labelDataPrivacy)
        Sets the display text for the data privacy page of the user portal.
        Parameters:
        labelDataPrivacy - The data privacy text.
        Returns:
        This builder for chaining method calls.

      • labelHelp

        public WelcomePageModel.Builder labelHelp​(String labelHelp)
        Sets the display text for the help page of the user portal.
        Parameters:
        labelHelp - The help text.
        Returns:
        This builder for chaining method calls.

      • labelImprint

        public WelcomePageModel.Builder labelImprint​(String labelImprint)
        Sets the display text for the imprint page of the user portal.
        Parameters:
        labelImprint - The imprint text.
        Returns:
        This builder for chaining method calls.

      • labelMailSupport

        public WelcomePageModel.Builder labelMailSupport​(String labelMailSupport)
        Sets the display text for the email support page of the user portal.
        Parameters:
        labelMailSupport - The email support text.
        Returns:
        This builder for chaining method calls.

      • labelTermsConditions

        public WelcomePageModel.Builder labelTermsConditions​(String labelTermsConditions)
        Sets the display text for the terms and conditions page of the user portal.
        Parameters:
        labelTermsConditions - The terms and conditions text.
        Returns:
        This builder for chaining method calls.

      • linkAccessibility

        public WelcomePageModel.Builder linkAccessibility​(String linkAccessibility)
        Sets the link for the accessibility page of the user portal.
        Parameters:
        linkAccessibility - The accessibility link.
        Returns:
        This builder for chaining method calls.

      • linkDataPrivacy

        public WelcomePageModel.Builder linkDataPrivacy​(String linkDataPrivacy)
        Sets the link for the data privacy page of the user portal.
        Parameters:
        linkDataPrivacy - The data privacy link.
        Returns:
        This builder for chaining method calls.

      • linkHelp

        public WelcomePageModel.Builder linkHelp​(String linkHelp)
        Sets the link for the help page of the user portal.
        Parameters:
        linkHelp - The help link.
        Returns:
        This builder for chaining method calls.

      • linkImprint

        public WelcomePageModel.Builder linkImprint​(String linkImprint)
        Sets the link for the imprint of the user portal.
        Parameters:
        linkImprint - The imprint link.
        Returns:
        This builder for chaining method calls.

      • linkMailSupport

        public WelcomePageModel.Builder linkMailSupport​(String linkMailSupport)
        Sets the link for the email support page of the user portal.
        Parameters:
        linkMailSupport - The email support link.
        Returns:
        This builder for chaining method calls.

      • linkTermsConditions

        public WelcomePageModel.Builder linkTermsConditions​(String linkTermsConditions)
        Sets the display text for the terms and conditions page of the user portal.
        Parameters:
        linkTermsConditions - The terms and conditions link.
        Returns:
        This builder for chaining method calls.

      • loginButtonLabel

        public WelcomePageModel.Builder loginButtonLabel​(String loginButtonLabel)
        Sets the display text for the login button on the welcome page.
        Parameters:
        loginButtonLabel - The login button text.
        Returns:
        This builder for chaining method calls.

      • subtitle

        public WelcomePageModel.Builder subtitle​(String subtitle)
        Sets the subtitle for the welcome page, displayed below the main title.
        Parameters:
        subtitle - The subtitle text.
        Returns:
        This builder for chaining method calls.

      • title

        public WelcomePageModel.Builder title​(String title)
        Sets the main title for the welcome page.
        Parameters:
        title - The title text.
        Returns:
        This builder for chaining method calls.

      • userPortalLocalizations

        public WelcomePageModel.Builder userPortalLocalizations​(de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource portal)
        Sets all properties from the localization of the given user portal resource.
        Parameters:
        portal - A user portal resource.
        Returns:
        This builder for chaining method calls.