Interface Shop

  • All Superinterfaces:
    PrettyPrintable

    public interface Shop
    extends PrettyPrintable
    The interface that represents a shop and contains all related data.
    Author:
    soknight
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  Shop.Copyright
      The instance that represents the copyright settings in the shop control panel.
      static interface  Shop.CustomizationTab
      The instance that represents the customization tab settings in the shop control panel.
      static interface  Shop.DeliveryMode
      The instance that represents the product delivery mode settings in the shop control panel.
      static interface  Shop.Extra
      The instance that represents the additional extra settings in the shop control panel.
      static interface  Shop.FunctionalTab
      The instance that represents the functional tab settings in the shop control panel.
      static interface  Shop.ImagesTab
      The instance that represents the images tab settings in the shop control panel.
      static interface  Shop.LinksTab
      The instance that represents the links tab settings in the shop control panel.
      static class  Shop.ParticlesType
      The enum that represents all possible and actual particles types.
      static interface  Shop.TestMode
      The instance that represents the test mode settings in the shop control panel.
    • Method Detail

      • getId

        int getId()
        Get a unique ID of this shop.
        Returns:
        The shop ID.
      • getName

        @NotNull
        @NotNull String getName()
        Get a displayable name of this shop.
        Returns:
        The shop name.
      • getDomain

        @NotNull
        @NotNull String getDomain()
        Get a current domain name of this shop.
        Returns:
        The current shop domain.
      • getLastDomain

        @NotNull
        @NotNull String getLastDomain()
        Get an original domain name of this shop.
        It's a domain name that has been set on the shop creation step.
        Returns:
        The original shop domain.
      • isActive

        boolean isActive()
        Check is this shop is active or not.
        If this method returned false that this shop has been blocked.
        By default, every shop will be active.
        Returns:
        The check result (true/false).
      • isPremium

        @Deprecated
        boolean isPremium()
        Deprecated.
        This feature will be revised later.
        Check is this shop has a premium subscription or not.
        Returns:
        The check result (true/false).
      • isVerified

        boolean isVerified()
        Check is this shop has been verified or not.
        Tip: To pass the verification check you need to verify all your servers via special key in the server MOTD.
        Returns:
        The check result (true/false).
      • getCreatedAt

        @NotNull
        @NotNull LocalDateTime getCreatedAt()
        Get a date when this shop was created.
        Returns:
        The shop creation date.
      • getUpdatedAt

        @NotNull
        @NotNull LocalDateTime getUpdatedAt()
        Get a date when this shop was modified recently.
        Returns:
        The last shop modification date.
      • deliveryMode

        @NotNull
        @NotNull Shop.DeliveryMode deliveryMode()
        Get the product delivery mode describing instance.
        Returns:
        The instance that represents the delivery mode settings.
        See Also:
        Shop.DeliveryMode
      • testMode

        @NotNull
        @NotNull Shop.TestMode testMode()
        Get the shop test mode describing instance.
        Returns:
        The instance that represents the test mode settings.
        See Also:
        Shop.TestMode
      • copyright

        @NotNull
        @NotNull Shop.Copyright copyright()
        Get the copyright settings describing instance.
        Returns:
        The instance that represents the copyright settings.
        See Also:
        Shop.Copyright
      • functionalTab

        @NotNull
        @NotNull Shop.FunctionalTab functionalTab()
        Get the instance that represents the Functional tab in the shop control panel.
        Returns:
        The instance that represents the functional tab settings.
        See Also:
        Shop.FunctionalTab
      • imagesTab

        @NotNull
        @NotNull Shop.ImagesTab imagesTab()
        Get the instance that represents the Images tab in the shop control panel.
        Returns:
        The instance that represents the functional tab settings.
        See Also:
        Shop.ImagesTab
      • linksTab

        @NotNull
        @NotNull Shop.LinksTab linksTab()
        Get the instance that represents the Links tab in the shop control panel.
        Returns:
        The instance that represents the links tab settings.
        See Also:
        Shop.LinksTab
      • customizationTab

        @NotNull
        @NotNull Shop.CustomizationTab customizationTab()
        Get the instance that represents the Customization tab in the shop control panel.
        Returns:
        The instance that represents the customization tab settings.
        See Also:
        Shop.CustomizationTab
      • extra

        @NotNull
        @NotNull Shop.Extra extra()
        Get the instance that store some other extra values from the shop settings.
        Returns:
        The instance that store some additional settings values.
        See Also:
        Shop.Extra