Interface MassSale

  • All Superinterfaces:
    PrettyPrintable

    public interface MassSale
    extends PrettyPrintable
    The interface that represents a mass sale and contains all related data.
    Author:
    soknight
    • Method Detail

      • getId

        int getId()
        Get the unique ID of this mass sale.
        Returns:
        The mass sale ID.
      • getShopId

        @NotNull
        @NotNull OptionalInt getShopId()
        Get the optional-wrapped ID of the owning shop.
        This field sometimes isn't exists in the response object.
        Returns:
        The optional-wrapped owning shop ID.
      • getName

        @NotNull
        @NotNull String getName()
        Get the name of this mass sale.
        Returns:
        The mass sale name.
      • getDiscountPercent

        double getDiscountPercent()
        Get the discount percent of this mass sale.
        It's a number from 1 to 100.
        Returns:
        The mass sale discount percent.
      • getProducts

        @NotNull
        @NotNull Optional<ProductsList> getProducts()
        Get the optional-wrapped list of related products.
        Returns:
        The optional-wrapped compatibly products list.
      • getStartsAt

        @NotNull
        @NotNull Optional<LocalDateTime> getStartsAt()
        Get the starting date of this mass sale.
        If the starting date wasn't actually specified, this method will return an empty Optional.
        Returns:
        The optional-wrapped mass sale starting date.
      • getExpiresAt

        @NotNull
        @NotNull Optional<LocalDateTime> getExpiresAt()
        Get the expiration date of this mass sale.
        If the expiration date wasn't actually specified, this method will return an empty Optional.
        Returns:
        The optional-wrapped mass sale expiration date.
      • getCreatedAt

        @NotNull
        @NotNull LocalDateTime getCreatedAt()
        Get the creation date for this mass sale.
        Returns:
        The mass sale creation date.
      • getUpdatedAt

        @NotNull
        @NotNull LocalDateTime getUpdatedAt()
        Get the date of last mass sale update.
        Returns:
        The last mass sale update date.