com.tectonica.jonix.common.struct.JonixSeriesIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jonix-common Show documentation

Collection of enums and other structures unifying Onix2 and Onix3 models

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.common.struct;

import com.tectonica.jonix.common.JonixKeyedStruct;
import com.tectonica.jonix.common.JonixStruct;
import com.tectonica.jonix.common.codelist.CollectionIdentifierTypes;

import java.io.Serializable;

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

/**
 * This class is a {@link JonixStruct} that represents Onix2 <SeriesIdentifier>.
 * 
 * It can be retrieved from the composite by invoking its asStruct() method.
 */
@SuppressWarnings("serial")
public class JonixSeriesIdentifier implements JonixKeyedStruct, Serializable {
    public static final JonixSeriesIdentifier EMPTY = new JonixSeriesIdentifier();

    /**
     * the key of this struct (by which it can be looked up)
     */
    public CollectionIdentifierTypes seriesIDType;

    /**
     * Raw Format: Free text, suggested maximum length 50 characters
     * 

     * (type: NonEmptyString)
     */
    public String idTypeName;

    /**
     * Raw Format: According to the identifier type specified in <ProductIDType>
     * 
     * (type: NonEmptyString)
     */
    public String idValue;

    @Override
    public CollectionIdentifierTypes key() {
        return seriesIDType;
    }
}