com.helger.masterdata.price.IPriceGraduation Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2018 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.masterdata.price;

import java.io.Serializable;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.lang.IHasSize;
import com.helger.masterdata.currency.ECurrency;
import com.helger.masterdata.currency.IHasCurrency;
import com.helger.masterdata.vat.IVATItem;

/**
 * Read only interface for a single complete price graduation (German:
 * Preisstaffelung). A price graduation is assembled from a list of price
 * graduation items.

 * The implementation needs to ensure, that each price graduation item's price
 * has the same currency, and that all items are sorted according to the minimum
 * quantity. The implementation should also ensure, that at least one entry for
 * the minimum quantity 1 exists. If you're selling certain items only in higher
 * quantities (e.g. balloons or other small things), you should instead use a
 * packaging unit (German: Verpackungseinheit) and define a quantity of 1.
 *
 * @see IPriceGraduationItem
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
public interface IPriceGraduation extends IHasSize, IHasCurrency, Serializable
{
  /**
   * @return The currency of this price graduation.
   * @throws IllegalStateException
   *         if no currency is defined
   */
  @Nonnull
  ECurrency getCurrency ();

  /**
   * @return The price graduation item with the smallest minimum quantity. May
   *         be null if no item is contained at all!
   */
  @Nullable
  IPriceGraduationItem getSmallestMinimumQuantityItem ();

  /**
   * @return The price graduation item with the smallest minimum quantity. May
   *         be null if no item is contained at all!
   */
  @Nullable
  IPriceGraduationItem getLargestMinimumQuantityItem ();

  /**
   * @return All contained read only items, sorted ascending by the minimum
   *         quantity. Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllItems ();

  /**
   * @param nIndex
   *        the index to be retrieved
   * @return The item at the given index or null if no such index
   *         is present.
   */
  @Nullable
  IPriceGraduationItem getItemOfIndex (@Nonnegative int nIndex);

  /**
   * Get the price of a single item, for the given quantity.
   *
   * @param nQuantity
   *        The quantity to query. Must be ≥ 1.
   * @param aVAT
   *        The VAT item to use.
   * @return The price of a single item.
   */
  @Nonnull
  IPrice getSinglePriceOfQuantity (@Nonnegative int nQuantity, @Nonnull IVATItem aVAT);

  /**
   * Get the total price of all items for the given quantity. This is a shortcut
   * for getSinglePriceOfQuantity (nQuantity).multiply (nQuantity)
   *
   * @param nQuantity
   *        The quantity to query. Must be ≥ 1.
   * @param aVAT
   *        The VAT item to use.
   * @return The total price of all items.
   */
  @Nonnull
  IPrice getTotalPriceOfQuantity (@Nonnegative int nQuantity, @Nonnull IVATItem aVAT);

  /**
   * Delivers a price object based on the net amount of the passed item and the
   * currency and VAT set for the price graduation
   *
   * @param aItem
   *        the price graduation item for which to retrieve the price
   * @param aVAT
   *        The VAT item to use.
   * @return the resulting {@link IPrice}
   */
  @Nonnull
  IPrice getPrice (@Nonnull IPriceGraduationItem aItem, @Nonnull IVATItem aVAT);
}