de.vdv.ojp20.EntitlementProductStructure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.5 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package de.vdv.ojp20;

import de.vdv.ojp20.siri.HalfOpenTimestampOutputRangeStructure;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.CollapsedStringAdapter;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * [a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".
 * 
 * Java class for EntitlementProductStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "EntitlementProductStructure", propOrder = {
    "fareAuthorityRef",
    "entitlementProductRef",
    "validityPeriod",
    "entitlementProductName"
})
public class EntitlementProductStructure {

    /**
     * Reference to the fare authority that issued the ENTITLEMENT PRODUCT
     * 
     */
    @XmlElement(name = "FareAuthorityRef", required = true)
    protected FareAuthorityRefStructure fareAuthorityRef;
    /**
     * Identifier of the ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First)
     * 
     */
    @XmlElement(name = "EntitlementProductRef", required = true)
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlSchemaType(name = "NMTOKEN")
    protected String entitlementProductRef;
    /**
     * Validity period of the ENTITLEMENT PRODUCT
     * 
     */
    @XmlElement(name = "ValidityPeriod")
    protected HalfOpenTimestampOutputRangeStructure validityPeriod;
    /**
     * Name of the ENTITLEMENT PRODUCT
     * 
     */
    @XmlElement(name = "EntitlementProductName", required = true)
    protected String entitlementProductName;

    /**
     * Reference to the fare authority that issued the ENTITLEMENT PRODUCT
     * 
     * @return
     *     possible object is
     *     {@link FareAuthorityRefStructure }
     *     
     */
    public FareAuthorityRefStructure getFareAuthorityRef() {
        return fareAuthorityRef;
    }

    /**
     * Sets the value of the fareAuthorityRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link FareAuthorityRefStructure }
     *     
     * @see #getFareAuthorityRef()
     */
    public void setFareAuthorityRef(FareAuthorityRefStructure value) {
        this.fareAuthorityRef = value;
    }

    /**
     * Identifier of the ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First)
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getEntitlementProductRef() {
        return entitlementProductRef;
    }

    /**
     * Sets the value of the entitlementProductRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getEntitlementProductRef()
     */
    public void setEntitlementProductRef(String value) {
        this.entitlementProductRef = value;
    }

    /**
     * Validity period of the ENTITLEMENT PRODUCT
     * 
     * @return
     *     possible object is
     *     {@link HalfOpenTimestampOutputRangeStructure }
     *     
     */
    public HalfOpenTimestampOutputRangeStructure getValidityPeriod() {
        return validityPeriod;
    }

    /**
     * Sets the value of the validityPeriod property.
     * 
     * @param value
     *     allowed object is
     *     {@link HalfOpenTimestampOutputRangeStructure }
     *     
     * @see #getValidityPeriod()
     */
    public void setValidityPeriod(HalfOpenTimestampOutputRangeStructure value) {
        this.validityPeriod = value;
    }

    /**
     * Name of the ENTITLEMENT PRODUCT
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getEntitlementProductName() {
        return entitlementProductName;
    }

    /**
     * Sets the value of the entitlementProductName property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getEntitlementProductName()
     */
    public void setEntitlementProductName(String value) {
        this.entitlementProductName = value;
    }

    public EntitlementProductStructure withFareAuthorityRef(FareAuthorityRefStructure value) {
        setFareAuthorityRef(value);
        return this;
    }

    public EntitlementProductStructure withEntitlementProductRef(String value) {
        setEntitlementProductRef(value);
        return this;
    }

    public EntitlementProductStructure withValidityPeriod(HalfOpenTimestampOutputRangeStructure value) {
        setValidityPeriod(value);
        return this;
    }

    public EntitlementProductStructure withEntitlementProductName(String value) {
        setEntitlementProductName(value);
        return this;
    }

    /**
     * Generates a String representation of the contents of this type.
     * This is an extension method, produced by the 'ts' xjc plugin
     * 
     */
    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this, OmitNullsToStringStyle.INSTANCE);
    }

}