com.tectonica.jonix.onix3.CurrencyCode Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2012-2024 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.onix3;

import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixElement;
import com.tectonica.jonix.common.codelist.CurrencyCodes;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;

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

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

/**
 * Currency code
 * 
 * An ISO standard code identifying the currency in which all monetary amounts in an occurrence of the <Price>
 * composite are stated. Optional and non-repeating, but required if the currency is not the default currency for the
 * message (which may be set in <DefaultCurrencyCode>). All ONIX messages must include an explicit statement of
 * the currency used for any prices. To avoid any possible ambiguity, it is strongly recommended that the currency
 * should be repeated here for each individual price.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Fixed length, three letters
Codelist ISO 4217 currency codes List 96
Reference name <CurrencyCode>
Short tag <j152>
Cardinality 0…1
Example <j152>ZAR</j152> (South African Rand)
 * 
 * This tag may be included in the following composites:
 * 

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

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

    public static final String refname = "CurrencyCode";
    public static final String shortname = "j152";

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

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

    /**
     * (type: dt.NonEmptyString)
     */
    public String sourcename;

    public RecordSourceTypes sourcetype;

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

    public CurrencyCodes value;

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

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

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

    public CurrencyCode() {
        exists = false;
    }

    public CurrencyCode(org.w3c.dom.Element element) {
        exists = true;
        datestamp = JPU.getAttribute(element, "datestamp");
        sourcename = JPU.getAttribute(element, "sourcename");
        sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));

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

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

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }

    public String codeOrNull() {
        return value == null ? null : value.code;
    }

    public String descriptionOrNull() {
        return value == null ? null : value.description;
    }
}
Format	Fixed length, three letters
Codelist	ISO 4217 currency codes List 96
Reference name	`<CurrencyCode>`
Short tag	`<j152>`
Cardinality	0…1
Example	`<j152>ZAR</j152>` (South African Rand)