Class ProductConfigureBreadcrumbBuilder


  • public class ProductConfigureBreadcrumbBuilder
    extends ProductBreadcrumbBuilder
    CPQ Bread crumb builder. It contains methods to build bread crumbs for the ConfigurationPage as well as the ConfigurationOverviewPage.
    • Field Detail

      • DEFAULT_TEXT_CART

        protected static final java.lang.String DEFAULT_TEXT_CART
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_CART_CONFIG

        protected static final java.lang.String DEFAULT_TEXT_CART_CONFIG
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_CONFIG

        protected static final java.lang.String DEFAULT_TEXT_CONFIG
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_DOCUMENT_OVERVIEW

        protected static final java.lang.String DEFAULT_TEXT_DOCUMENT_OVERVIEW
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_OVERVIEW

        protected static final java.lang.String DEFAULT_TEXT_OVERVIEW
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_QUOTES

        protected static final java.lang.String DEFAULT_TEXT_QUOTES
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_ORDERS

        protected static final java.lang.String DEFAULT_TEXT_ORDERS
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_SAVED_CARTS

        protected static final java.lang.String DEFAULT_TEXT_SAVED_CARTS
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_SINGLE_QUOTE

        protected static final java.lang.String DEFAULT_TEXT_SINGLE_QUOTE
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_SINGLE_ORDER

        protected static final java.lang.String DEFAULT_TEXT_SINGLE_ORDER
        See Also:
        Constant Field Values
      • DEFAULT_TEXT_SINGLE_SAVED_CART

        protected static final java.lang.String DEFAULT_TEXT_SINGLE_SAVED_CART
        See Also:
        Constant Field Values
      • RESOURCE_KEY_OVERVIEW

        protected static final java.lang.String RESOURCE_KEY_OVERVIEW
        See Also:
        Constant Field Values
      • RESOURCE_KEY_CONFIG

        protected static final java.lang.String RESOURCE_KEY_CONFIG
        See Also:
        Constant Field Values
      • RESOURCE_KEY_CART

        protected static final java.lang.String RESOURCE_KEY_CART
        See Also:
        Constant Field Values
      • RESOURCE_KEY_CART_CONFIG

        protected static final java.lang.String RESOURCE_KEY_CART_CONFIG
        See Also:
        Constant Field Values
      • RESOURCE_KEY_DOCUMENT_OVERVIEW

        protected static final java.lang.String RESOURCE_KEY_DOCUMENT_OVERVIEW
        See Also:
        Constant Field Values
      • RESOURCE_KEY_SINGLE_QUOTE

        protected static final java.lang.String RESOURCE_KEY_SINGLE_QUOTE
        See Also:
        Constant Field Values
      • RESOURCE_KEY_SINGLE_ORDER

        protected static final java.lang.String RESOURCE_KEY_SINGLE_ORDER
        See Also:
        Constant Field Values
      • RESOURCE_KEY_SINGLE_SAVED_CART

        protected static final java.lang.String RESOURCE_KEY_SINGLE_SAVED_CART
        See Also:
        Constant Field Values
      • RESOURCE_KEY_QUOTES

        protected static final java.lang.String RESOURCE_KEY_QUOTES
        See Also:
        Constant Field Values
      • RESOURCE_KEY_ORDERS

        protected static final java.lang.String RESOURCE_KEY_ORDERS
        See Also:
        Constant Field Values
      • RESOURCE_KEY_SAVED_CARTS

        protected static final java.lang.String RESOURCE_KEY_SAVED_CARTS
        See Also:
        Constant Field Values
      • URL_MY_ACCOUNT_MY_QUOTES

        protected static final java.lang.String URL_MY_ACCOUNT_MY_QUOTES
        See Also:
        Constant Field Values
      • URL_MY_ACCOUNT_ORDER

        protected static final java.lang.String URL_MY_ACCOUNT_ORDER
        See Also:
        Constant Field Values
      • URL_MY_ACCOUNT_ORDERS

        protected static final java.lang.String URL_MY_ACCOUNT_ORDERS
        See Also:
        Constant Field Values
      • URL_MY_ACCOUNT_SAVED_CARTS

        protected static final java.lang.String URL_MY_ACCOUNT_SAVED_CARTS
        See Also:
        Constant Field Values
    • Constructor Detail

      • ProductConfigureBreadcrumbBuilder

        public ProductConfigureBreadcrumbBuilder()
    • Method Detail

      • getBreadcrumbs

        public java.util.List<Breadcrumb> getBreadcrumbs​(java.lang.String productCode)
        Builds the breadcrumbs when the configuration page is accessed.
        Overrides:
        getBreadcrumbs in class ProductBreadcrumbBuilder
        Parameters:
        productCode -
        Returns:
        bread crumb list
      • getBreadcrumbs

        public java.util.List<Breadcrumb> getBreadcrumbs​(java.lang.String productCode,
                                                         java.lang.Integer cartEntryNumber)
        Builds the breadcrumbs when the configuration page is accessed from the cart.
        Parameters:
        productCode -
        cartEntryNumber -
        Returns:
        bread crumb list
      • getOverviewBreadcrumbs

        public java.util.List<Breadcrumb> getOverviewBreadcrumbs​(java.lang.String productCode,
                                                                 OverviewUiData overviewUiData)
        Builds the breadcrumbs for the OverviewPage. The exact structure depends on the context in which the overview page is displayed.
        Parameters:
        productCode -
        overviewUiData - context of the overview page
        Returns:
        bread crumb list
      • getOverviewBreadcrumbs

        protected java.util.List<Breadcrumb> getOverviewBreadcrumbs​(java.lang.String productCode,
                                                                    java.lang.Integer cartEntryNumber)
      • getOverviewBreadcrumbsForConfigFromCart

        protected java.util.List<Breadcrumb> getOverviewBreadcrumbsForConfigFromCart​(java.lang.String productCode,
                                                                                     java.lang.Integer cartEntryNumber)
      • getBreadcrumbsForConfigFromCart

        public java.util.List<Breadcrumb> getBreadcrumbsForConfigFromCart​(java.lang.String productCode,
                                                                          java.lang.Integer cartEntryNumber)
        Builds the breadcrumbs when the configuration page is accessed from the cart.
        Parameters:
        productCode -
        cartEntryNumber -
        Returns:
        bread crumb list
      • getBreadcrumbsForConfigFromCartOnExistingDraft

        protected java.util.List<Breadcrumb> getBreadcrumbsForConfigFromCartOnExistingDraft​(java.lang.String productCode,
                                                                                            java.lang.Integer cartEntryNumber)
      • getConfigFromCartURL

        protected java.lang.String getConfigFromCartURL​(java.lang.Integer cartEntryNumber,
                                                        boolean isFromExistingDraft)
      • getOverviewBreadcrumbsForQuotation

        protected java.util.List<Breadcrumb> getOverviewBreadcrumbsForQuotation​(java.lang.String sourceDocumentId)
      • getLocalizedTextOrDefault

        protected java.lang.String getLocalizedTextOrDefault​(java.lang.String key,
                                                             java.lang.String defaultText)
      • getLocalizedTextOrDefault

        protected java.lang.String getLocalizedTextOrDefault​(java.lang.String key,
                                                             java.lang.String defaultText,
                                                             java.lang.Object[] args)
      • formatDefaultText

        protected java.lang.String formatDefaultText​(java.lang.String defaultText,
                                                     java.lang.Object[] args)
      • callLocalization

        protected java.lang.String callLocalization​(java.lang.String key,
                                                    java.lang.Object[] args)
      • getCurrentQuoteText

        protected java.lang.String getCurrentQuoteText​(java.lang.String sourceDocumentId)
      • getCurrentOrderText

        protected java.lang.String getCurrentOrderText​(java.lang.String sourceDocumentId)
      • getCurrentSavedCartText

        protected java.lang.String getCurrentSavedCartText​(java.lang.String sourceDocumentId)
      • getCurrentCartEntryConfigText

        protected java.lang.String getCurrentCartEntryConfigText​(java.lang.String productCode)
      • urlEncode

        protected java.lang.String urlEncode​(java.lang.String url)
      • getOverviewBreadcrumbsForProduct

        protected java.util.List<Breadcrumb> getOverviewBreadcrumbsForProduct​(java.lang.String productCode)
      • getVariantOverviewBreadcrumbs

        public java.util.List<Breadcrumb> getVariantOverviewBreadcrumbs​(java.lang.String baseProduct,
                                                                        java.lang.String productCode)
        Builds the breadcrumbs when the configuration overview page is accessed in context of a product variant.
        Parameters:
        baseProduct - code of the base product of the variant
        productCode -
        Returns:
        bread crumb list
      • getVariantOverviewCartContextBreadcrumbs

        public java.util.List<Breadcrumb> getVariantOverviewCartContextBreadcrumbs​(java.lang.String baseProduct,
                                                                                   java.lang.String code,
                                                                                   java.lang.Integer cartEntryNumber)
        Builds the breadcrumbs when the variant overview page is accessed from the cart.
        Parameters:
        baseProduct - code of the base product of the variant
        code - product code
        cartEntryNumber - cart entry number
        Returns:
      • getLinkText

        protected java.lang.String getLinkText()
      • getCartText

        protected java.lang.String getCartText()
      • getOverviewLinkText

        protected java.lang.String getOverviewLinkText()
      • getOverviewAccountLinkText

        protected java.lang.String getOverviewAccountLinkText()
      • getQuotesText

        protected java.lang.String getQuotesText()
      • getOrderText

        protected java.lang.String getOrderText()
      • getSavedCartText

        protected java.lang.String getSavedCartText()
      • getUrl

        protected java.lang.String getUrl​(java.lang.String productCode,
                                          java.lang.String appendUrl)
      • setAccountBreadcrumbBuilder

        public void setAccountBreadcrumbBuilder​(ResourceBreadcrumbBuilder accountBreadcrumbBuilder)
        Parameters:
        accountBreadcrumbBuilder - the accountBreadcrumbBuilder to set
      • getOverviewBreadcrumbsForOrder

        protected java.util.List<Breadcrumb> getOverviewBreadcrumbsForOrder​(java.lang.String orderId)
      • getOverviewBreadcrumbsForSavedCart

        protected java.util.List<Breadcrumb> getOverviewBreadcrumbsForSavedCart​(java.lang.String sourceDocumentId)