io.konik.zugferd.entity.TaxRegistration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of konik Show documentation
Konik the ZUGFeRD processing library
The newest version!
/*
 * Copyright (C) 2014 konik.io
 *
 * This file is part of Konik library.
 *
 * 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.
 *
 * 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 Konik library.  If not, see .
 */
package io.konik.zugferd.entity;

import static io.konik.util.Strings.isNotEmpty;

import java.io.Serializable;

import javax.validation.constraints.NotNull;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

import io.konik.validator.annotation.NotBlank;
import io.konik.zugferd.unece.codes.Reference;
import io.konik.zugferd.unqualified.ID;

/**
 * = The Tax Registration
 * 
 * Represents the tax number and its type.
 * The {@link ID#getValue()} is value added tax identification number
 * The {@link ID#getSchemeId()} is the Tax payer's number or VAT number according to (UNCL 1153) eg. FC or VA
 */
@XmlType(name = "TaxRegistrationType", propOrder = { "id" })
public class TaxRegistration implements Serializable {

   @XmlElement(name = "ID")
   private ID id;

   /** Instantiates a new tax registration. */
   public TaxRegistration() {
      this.id = new ID();
   }

   /**
    * Instantiates a new tax registration without a type.
    * 
    * @param taxNumber the id
    */
   public TaxRegistration(String taxNumber) {
      this.id = new ID(taxNumber);
   }

   /**
    * Instantiates a new tax registration.
    * 
    * @param taxNumber the tax id
    * @param typeOfTax the scheme id
    */
   public TaxRegistration(String taxNumber, Reference typeOfTax) {
      this.id = new ID(taxNumber, typeOfTax.getCode());
   }

   /**
    * Gets the tax number.
    * 
    * Example:: {@code DE234567891}
    * 
    * @return the number
    */
   @NotBlank
   public String getTaxNumber() {
      return id.getValue();
   }

   /**
    * Sets the tax number.
    * 
    * Example:: {@code DE234567891}
    *
    * @param taxNumber the new value
    * @return the tax registration
    */
   public TaxRegistration setTaxNumber(String taxNumber) {
      if (isNotEmpty(taxNumber)) {
         this.id.setValue(taxNumber);
      }
      return this;
   }

   /**
    * Gets the tax type. The UNCL 1153 tax type.
    * 
    * Example:: {@code VA}
    *
    * @return the type
    */
   @NotNull
   public Reference getType() {
      return Reference.getByCode(id.getSchemeId());
   }

   /**
    * Sets the UNCL 1153 tax type.
    * 
    * Example:: {@code VA}
    *
    * @param taxType the new type
    * @return the tax registration
    */
   public TaxRegistration setType(Reference taxType) {
      if (taxType != null) {
         this.id.setSchemeId(taxType.getCode());
      }
      return this;
   }

}