com.tectonica.jonix.onix2.TaxRateCode1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jonix-onix2 Show documentation
Collection of classes for processing Onix-2 sources
There is a newer version: 2024-10-onix308
/*
 * Copyright (C) 2012-2023 Zach Melamed
 *
 * Latest version available online at https://github.com/zach-m/jonix
 * Contact me at [email protected]
 *
 * 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.tectonica.jonix.onix2;

import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixElement;
import com.tectonica.jonix.common.codelist.Languages;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import com.tectonica.jonix.common.codelist.TaxRateTypes;
import com.tectonica.jonix.common.codelist.TextCaseFlags;
import com.tectonica.jonix.common.codelist.TextFormats;
import com.tectonica.jonix.common.codelist.TransliterationSchemes;

import java.io.Serializable;
import java.util.function.Consumer;

/*
 * NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
 */

/**
 * Tax rate 1, coded
 * 
 * A code which specifies a value added tax rate applying to the whole of the price, or to the amount of the price which
 * is specified in <TaxableAmount1> if present. Optional and non-repeating.
 * 
 * 
 * If the product is taxable at a single rate, or is wholly exempt or zero-rated, <TaxRateCode1> may be sent on
 * its own, or with any combination of <TaxRatePercent1>, <TaxableAmount1> and <TaxAmount1>, although
 * it is best practise to send all these three elements.
 * 
 * 
 * If the product carries mixed tax rates, the minimum requirement is to send <TaxRateCode1>,
 * <TaxRateCode2>, <TaxableAmount1> and <TaxableAmount2>, though again best practise would be to send
 * all eight tax elements so that the tax calculation is made entirely explicit.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Fixed-length, one letter.
Codelist List 62
Reference name <TaxRateCode1>
Short tag <j153>
Example <TaxRateCode1>Z</TaxRateCode1> Zero-rated
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link Price}>
 * 
 * 
 * Possible placements within ONIX message:
 * 

 * {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link Price} ⯈ {@link TaxRateCode1}
 * {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link Reissue} ⯈ {@link Price} ⯈ {@link TaxRateCode1}
 * 
 */
public class TaxRateCode1 implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "TaxRateCode1";
    public static final String shortname = "j153";

    /////////////////////////////////////////////////////////////////////////////////
    // ATTRIBUTES
    /////////////////////////////////////////////////////////////////////////////////

    public TextFormats textformat;

    public TextCaseFlags textcase;

    public Languages language;

    public TransliterationSchemes transliteration;

    /**
     * (type: DateOrDateTime)
     */
    public String datestamp;

    public RecordSourceTypes sourcetype;

    public String sourcename;

    /////////////////////////////////////////////////////////////////////////////////
    // VALUE MEMBER
    /////////////////////////////////////////////////////////////////////////////////

    public TaxRateTypes value;

    /**
     * Internal API, use the {@link #value()} method or the {@link #value} field instead
     */
    @Override
    public TaxRateTypes __v() {
        return value;
    }

    /////////////////////////////////////////////////////////////////////////////////
    // SERVICES
    /////////////////////////////////////////////////////////////////////////////////

    private final boolean exists;
    public static final TaxRateCode1 EMPTY = new TaxRateCode1();

    public TaxRateCode1() {
        exists = false;
    }

    public TaxRateCode1(org.w3c.dom.Element element) {
        exists = true;
        textformat = TextFormats.byCode(JPU.getAttribute(element, "textformat"));
        textcase = TextCaseFlags.byCode(JPU.getAttribute(element, "textcase"));
        language = Languages.byCode(JPU.getAttribute(element, "language"));
        transliteration = TransliterationSchemes.byCode(JPU.getAttribute(element, "transliteration"));
        datestamp = JPU.getAttribute(element, "datestamp");
        sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));
        sourcename = JPU.getAttribute(element, "sourcename");

        value = TaxRateTypes.byCode(JPU.getContentAsString(element));
    }

    /**
     * @return whether this tag (<TaxRateCode1> or <j153>) is explicitly provided in the ONIX XML
     */
    @Override
    public boolean exists() {
        return exists;
    }

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }
}
Format	Fixed-length, one letter.
Codelist	List 62
Reference name	`<TaxRateCode1>`
Short tag	`<j153>`
Example	`<TaxRateCode1>Z</TaxRateCode1>` Zero-rated