Package com.commercetools.api.models.store

Interface Storefront

public interface Storefront

Customer-facing URLs and policy links for the Store's storefront. All fields are optional and only present when set.

Example to create an instance using the builder pattern 

     Storefront storefront = Storefront.builder()
             .build()

  • Method Details

    • getCheckoutUrlTemplate

      String getCheckoutUrlTemplate()

      RFC 6570 URI template for the customer-facing checkout page. Must contain the checkoutId variable, for example https://example.com/checkout/{checkoutId}.

      Returns:
      checkoutUrlTemplate

    • getOrderUrlTemplate

      String getOrderUrlTemplate()

      RFC 6570 URI template for the customer-facing order status page. Must contain the orderId variable, for example https://example.com/orders/{orderId}.

      Returns:
      orderUrlTemplate

    • getTermsOfServiceUrl

      String getTermsOfServiceUrl()

      Absolute https URL of the storefront's terms of service page.

      Returns:
      termsOfServiceUrl

    • getPrivacyPolicyUrl

      String getPrivacyPolicyUrl()

      Absolute https URL of the storefront's privacy policy page.

      Returns:
      privacyPolicyUrl

    • getRefundPolicyUrl

      String getRefundPolicyUrl()

      Absolute https URL of the storefront's refund policy page.

      Returns:
      refundPolicyUrl

    • getShippingPolicyUrl

      String getShippingPolicyUrl()

      Absolute https URL of the storefront's shipping policy page.

      Returns:
      shippingPolicyUrl

    • getCookiePolicyUrl

      String getCookiePolicyUrl()

      Absolute https URL of the storefront's cookie policy page.

      Returns:
      cookiePolicyUrl

    • getImprintUrl

      String getImprintUrl()

      Absolute https URL of the storefront's imprint (legal notice) page.

      Returns:
      imprintUrl

    • getFaqUrl

      String getFaqUrl()

      Absolute https URL of the storefront's FAQ page.

      Returns:
      faqUrl

    • getContactUrl

      String getContactUrl()

      Absolute https URL of the storefront's contact page.

      Returns:
      contactUrl

    • setCheckoutUrlTemplate

      void setCheckoutUrlTemplate(String checkoutUrlTemplate)

      RFC 6570 URI template for the customer-facing checkout page. Must contain the checkoutId variable, for example https://example.com/checkout/{checkoutId}.

      Parameters:
      checkoutUrlTemplate - value to be set

    • setOrderUrlTemplate

      void setOrderUrlTemplate(String orderUrlTemplate)

      RFC 6570 URI template for the customer-facing order status page. Must contain the orderId variable, for example https://example.com/orders/{orderId}.

      Parameters:
      orderUrlTemplate - value to be set

    • setTermsOfServiceUrl

      void setTermsOfServiceUrl(String termsOfServiceUrl)

      Absolute https URL of the storefront's terms of service page.

      Parameters:
      termsOfServiceUrl - value to be set

    • setPrivacyPolicyUrl

      void setPrivacyPolicyUrl(String privacyPolicyUrl)

      Absolute https URL of the storefront's privacy policy page.

      Parameters:
      privacyPolicyUrl - value to be set

    • setRefundPolicyUrl

      void setRefundPolicyUrl(String refundPolicyUrl)

      Absolute https URL of the storefront's refund policy page.

      Parameters:
      refundPolicyUrl - value to be set

    • setShippingPolicyUrl

      void setShippingPolicyUrl(String shippingPolicyUrl)

      Absolute https URL of the storefront's shipping policy page.

      Parameters:
      shippingPolicyUrl - value to be set

    • setCookiePolicyUrl

      void setCookiePolicyUrl(String cookiePolicyUrl)

      Absolute https URL of the storefront's cookie policy page.

      Parameters:
      cookiePolicyUrl - value to be set

    • setImprintUrl

      void setImprintUrl(String imprintUrl)

      Absolute https URL of the storefront's imprint (legal notice) page.

      Parameters:
      imprintUrl - value to be set

    • setFaqUrl

      void setFaqUrl(String faqUrl)

      Absolute https URL of the storefront's FAQ page.

      Parameters:
      faqUrl - value to be set

    • setContactUrl

      void setContactUrl(String contactUrl)

      Absolute https URL of the storefront's contact page.

      Parameters:
      contactUrl - value to be set

    • of

      static Storefront of()
      factory method
      Returns:
      instance of Storefront

    • of

      static Storefront of(Storefront template)
      factory method to create a shallow copy Storefront
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      Storefront copyDeep()

    • deepCopy

      @Nullable static Storefront deepCopy(@Nullable Storefront template)
      factory method to create a deep copy of Storefront
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static StorefrontBuilder builder()
      builder factory method for Storefront
      Returns:
      builder

    • builder

      static StorefrontBuilder builder(Storefront template)
      create builder for Storefront instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withStorefront

      default <T> T withStorefront(Function<Storefront,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<Storefront> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference