de.vdv.ojp20.FarePassengerStructure 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 java.math.BigInteger;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
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 org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;


/**
 * [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT.
 * 
 * Java class for FarePassengerStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *           
 *           
 *         
 *         
 *         
 *           
 *           
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "FarePassengerStructure", propOrder = {
    "age",
    "passengerCategory",
    "entitlementProducts",
    "zonesAlreadyPaid",
    "salesPackageElementRef"
})
public class FarePassengerStructure {

    /**
     * Age of the passenger on the day of travel.
     * 
     */
    @XmlElement(name = "Age")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected BigInteger age;
    /**
     * sequence of all passenger categories, for which this FareProduct is valid
     * 
     */
    @XmlElement(name = "PassengerCategory")
    @XmlSchemaType(name = "string")
    protected PassengerCategoryEnumeration passengerCategory;
    /**
     * A list of ENTITLEMENT PRODUCTs.
     * 
     */
    @XmlElement(name = "EntitlementProducts")
    protected EntitlementProductListStructure entitlementProducts;
    /**
     * Fare zones for which the passenger already has a valid FareProduct.
     * 
     */
    @XmlElement(name = "ZonesAlreadyPaid")
    protected TariffZoneRefListStructure zonesAlreadyPaid;
    /**
     * Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.
     * 
     */
    @XmlElement(name = "SalesPackageElementRef")
    protected List salesPackageElementRef;

    /**
     * Age of the passenger on the day of travel.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getAge() {
        return age;
    }

    /**
     * Sets the value of the age property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigInteger }
     *     
     * @see #getAge()
     */
    public void setAge(BigInteger value) {
        this.age = value;
    }

    /**
     * sequence of all passenger categories, for which this FareProduct is valid
     * 
     * @return
     *     possible object is
     *     {@link PassengerCategoryEnumeration }
     *     
     */
    public PassengerCategoryEnumeration getPassengerCategory() {
        return passengerCategory;
    }

    /**
     * Sets the value of the passengerCategory property.
     * 
     * @param value
     *     allowed object is
     *     {@link PassengerCategoryEnumeration }
     *     
     * @see #getPassengerCategory()
     */
    public void setPassengerCategory(PassengerCategoryEnumeration value) {
        this.passengerCategory = value;
    }

    /**
     * A list of ENTITLEMENT PRODUCTs.
     * 
     * @return
     *     possible object is
     *     {@link EntitlementProductListStructure }
     *     
     */
    public EntitlementProductListStructure getEntitlementProducts() {
        return entitlementProducts;
    }

    /**
     * Sets the value of the entitlementProducts property.
     * 
     * @param value
     *     allowed object is
     *     {@link EntitlementProductListStructure }
     *     
     * @see #getEntitlementProducts()
     */
    public void setEntitlementProducts(EntitlementProductListStructure value) {
        this.entitlementProducts = value;
    }

    /**
     * Fare zones for which the passenger already has a valid FareProduct.
     * 
     * @return
     *     possible object is
     *     {@link TariffZoneRefListStructure }
     *     
     */
    public TariffZoneRefListStructure getZonesAlreadyPaid() {
        return zonesAlreadyPaid;
    }

    /**
     * Sets the value of the zonesAlreadyPaid property.
     * 
     * @param value
     *     allowed object is
     *     {@link TariffZoneRefListStructure }
     *     
     * @see #getZonesAlreadyPaid()
     */
    public void setZonesAlreadyPaid(TariffZoneRefListStructure value) {
        this.zonesAlreadyPaid = value;
    }

    /**
     * Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.
     * 
     * Gets the value of the salesPackageElementRef property.
     * 
     * This accessor method returns a reference to the live list,
     * not a snapshot. Therefore any modification you make to the
     * returned list will be present inside the JAXB object.
     * This is why there is not a set method for the salesPackageElementRef property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getSalesPackageElementRef().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link FareProductRefStructure }
     * 
     * 
     * 
     * @return
     *     The value of the salesPackageElementRef property.
     */
    public List getSalesPackageElementRef() {
        if (salesPackageElementRef == null) {
            salesPackageElementRef = new ArrayList<>();
        }
        return this.salesPackageElementRef;
    }

    public FarePassengerStructure withAge(BigInteger value) {
        setAge(value);
        return this;
    }

    public FarePassengerStructure withPassengerCategory(PassengerCategoryEnumeration value) {
        setPassengerCategory(value);
        return this;
    }

    public FarePassengerStructure withEntitlementProducts(EntitlementProductListStructure value) {
        setEntitlementProducts(value);
        return this;
    }

    public FarePassengerStructure withZonesAlreadyPaid(TariffZoneRefListStructure value) {
        setZonesAlreadyPaid(value);
        return this;
    }

    public FarePassengerStructure withSalesPackageElementRef(FareProductRefStructure... values) {
        if (values!= null) {
            for (FareProductRefStructure value: values) {
                getSalesPackageElementRef().add(value);
            }
        }
        return this;
    }

    public FarePassengerStructure withSalesPackageElementRef(Collection values) {
        if (values!= null) {
            getSalesPackageElementRef().addAll(values);
        }
        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);
    }

}