Delivery.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;

import io.konik.validator.annotation.Comfort;
import io.konik.validator.annotation.Extended;
import io.konik.zugferd.entity.CommonDelivery;
import io.konik.zugferd.entity.Consignment;
import io.konik.zugferd.entity.ReferencedDocument;
import io.konik.zugferd.entity.TradeParty;
import io.konik.zugferd.unqualified.ZfDate;

import javax.validation.Valid;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
 * = The trade delivery information.
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlType(propOrder = { "relatedConsignment", "shipTo", "ultimateShipTo", "shipFrom", "actualDelivery",
      "despatchAdvice", "deliveryNote" })
public class Delivery extends CommonDelivery<ReferencedDocument> {
  
   @XmlElement(name = "RelatedSupplyChainConsignment")
   private Consignment relatedConsignment;

   @XmlElement(name = "ShipFromTradeParty")
   private TradeParty shipFrom;

   @XmlElement(name = "DespatchAdviceReferencedDocument")
   private ReferencedDocument despatchAdvice;

   @XmlElement(name = "DeliveryNoteReferencedDocument")
   private ReferencedDocument deliveryNote;

   Delivery() {
      super();
   }

   /**
    * The Constructor.
    * 
    * @param actualDelivery
    */
   public Delivery(ZfDate actualDelivery) {
      super();
      setActualDelivery(actualDelivery);
   }

   /**
    * Gets the related consignment.
    *
    * @return the related consignment
    */
   @Valid
   @Extended
   public Consignment getRelatedConsignment() {
      return relatedConsignment;
   }

   /**
    * Sets the related consignment.
    *
    * @param relatedConsignment the related consignment
    * @return the trade delivery
    */
   public Delivery setRelatedConsignment(Consignment relatedConsignment) {
      this.relatedConsignment = relatedConsignment;
      return this;
   }

   @Valid
   @Extended
   @Override
   public TradeParty getShipTo() {
      return super.getShipTo();
   }

   @Valid
   @Extended
   @Override
   public TradeParty getUltimateShipTo() {
      return super.getUltimateShipTo();
   }
   /**
    * Gets the ship from.
    *
    * @return the ship from
    */
   @Valid
   @Extended
   public TradeParty getShipFrom() {
      return shipFrom;
   }

   /**
    * Sets the ship from.
    *
    * @param shipFrom the ship from
    * @return the trade delivery
    */
   public Delivery setShipFrom(TradeParty shipFrom) {
      this.shipFrom = shipFrom;
      return this;
   }
   
   @Valid
   @Extended
   @Override
   public ReferencedDocument getDespatchAdvice() {
      return despatchAdvice;
   }

   @Override
   public Delivery setDespatchAdvice(ReferencedDocument despatchAdvice) {
      this.despatchAdvice = despatchAdvice;
      return this;
   }

   @Valid
   @Comfort
   @Override
   public ReferencedDocument getDeliveryNote() {
      return deliveryNote;
   }

   @Override
   public Delivery setDeliveryNote(ReferencedDocument deliveryNote) {
      this.deliveryNote = deliveryNote;
      return this;
   }

}