SpecifiedAgreement.java

/* Copyright (C) 2014 konik.io
 *
 * This file is part of the Konik library.
 *
 * The Konik library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The Konik library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with the Konik library. If not, see <http://www.gnu.org/licenses/>.
 */
package io.konik.zugferd.entity.trade.item;

import io.konik.validator.annotation.Extended;
import io.konik.zugferd.entity.CommonAgreement;
import io.konik.zugferd.entity.GrossPrice;
import io.konik.zugferd.entity.Price;

import javax.validation.Valid;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import java.util.ArrayList;
import java.util.List;

/**
 * = The Agreement used on the trade item level.
 */
@XmlType(propOrder = { "buyerOrder", "contract", "additional", "grossPrice", "netPrice", "customerOrder" })
public class SpecifiedAgreement implements CommonAgreement<ReferencedDocumentItem, ReferencedDocumentItemAdditional> {

   private ReferencedDocumentItem buyerOrder;
   private ReferencedDocumentItem contract;
   private List<ReferencedDocumentItemAdditional> additional;
   private GrossPrice grossPrice;
   private Price netPrice;
   private ReferencedDocumentItem customerOrder;

  
   @Valid
   @Extended
   @Override
   @XmlElement(name = "BuyerOrderReferencedDocument")
   public ReferencedDocumentItem getBuyerOrder() {
      return buyerOrder;
   }

   @Override
   public SpecifiedAgreement setBuyerOrder(ReferencedDocumentItem buyerOrder) {
      this.buyerOrder = buyerOrder;
      return this;
   }

   @Valid
   @Extended
   @Override
   @XmlElement(name = "ContractReferencedDocument")
   public ReferencedDocumentItem getContract() {
      return contract;
   }
   
   @Valid
   @Extended
   @Override
   public SpecifiedAgreement setContract(ReferencedDocumentItem contract) {
      this.contract = contract;
      return this;
   }

   @Valid
   @Extended
   @Override
   @XmlElement(name = "AdditionalReferencedDocument")
   public List<ReferencedDocumentItemAdditional> getAdditional() {
      if (additional == null) {
         additional = new ArrayList<ReferencedDocumentItemAdditional>();
      }
      return additional;
   }

   @Override
   public SpecifiedAgreement addAdditional(ReferencedDocumentItemAdditional additionalReference) {
      getAdditional().add(additionalReference);
      return this;
   }

   /**
    * Gets details on item based gross price excluding taxes
    *
    * @return the item gross price
    */
   @Valid
   @XmlElement(name = "GrossPriceProductTradePrice")
   public GrossPrice getGrossPrice() {
      return grossPrice;
   }

   /**
    * Sets details on item based gross price excluding taxes.
    *
    * @param grossPrice the new  the item gross price
    * @return the specified agreement
    */
   public SpecifiedAgreement setGrossPrice(GrossPrice grossPrice) {
      this.grossPrice = grossPrice;
      return this;
   }

   /**
    * Gets the details on net price without tax
    * The net prices included all allowances and charges, but no taxes.
    *
    * @return the net price product trade price
    */
   @Valid
   @XmlElement(name = "NetPriceProductTradePrice")
   public Price getNetPrice() {
      return netPrice;
   }

   /**
    * Sets the details on net price without tax
    * The net prices included all allowances and charges, but no taxes.
    *
    * @param netPrice the new net price product trade price
    * @return the supply chain trade agreement
    */
   public SpecifiedAgreement setNetPrice(Price netPrice) {
      this.netPrice = netPrice;
      return this;
   }

   /**
    * Gets the customer order referenced document.
    * 
    * @return the customer order referenced document
    */
   @Valid
   @Extended
   @Override
   @XmlElement(name = "CustomerOrderReferencedDocument")
   public ReferencedDocumentItem getCustomerOrder() {
      return customerOrder;
   }

   /**
    * Sets the customer order referenced document.
    * 
    * @param customerOrder the new customer order referenced document
    * @return the supply chain trade agreement
    */
   @Override
   public SpecifiedAgreement setCustomerOrder(ReferencedDocumentItem customerOrder) {
      this.customerOrder = customerOrder;
      return this;
   }

}