de.vdv.ojp20.FareParamStructure 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.util.ArrayList;
import java.util.Collection;
import java.util.List;
import de.vdv.ojp20.siri.FareClassEnumeration;
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;


/**
 * [related to the FARE parameter model in TM and NeTEx] parameters which are used to determine the price to be paid for a FARE PRODUCT by a specific passenger.
 * 
 * Java class for FareParamStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "FareParamStructure", propOrder = {
    "fareAuthorityFilter",
    "passengerCategory",
    "fareClass",
    "traveller",
    "accessModeList",
    "extension"
})
public class FareParamStructure {

    /**
     * Fare authority for which to retrieve Fare information.
     * 
     */
    @XmlElement(name = "FareAuthorityFilter")
    protected List fareAuthorityFilter;
    /**
     * sequence of all passenger categories, for which this FareProduct is valid
     * 
     */
    @XmlElement(name = "PassengerCategory")
    @XmlSchemaType(name = "string")
    protected List passengerCategory;
    /**
     * Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g., first class). Transmodel: CLASS OF USE.
     * 
     */
    @XmlElement(name = "FareClass")
    @XmlSchemaType(name = "NMTOKEN")
    protected FareClassEnumeration fareClass;
    /**
     * Number of travellers that will make the journey and for which Fare information needs to be gathered.
     * 
     */
    @XmlElement(name = "Traveller")
    protected List traveller;
    /**
     * ACCESS MODEs to consider (usually only one). This is only used in very special cases. E.g. for carTransportRail. It indicates if one uses a car, truck, motorcycle or bike. The Access mode may result in no transportation being possible.
     * 
     */
    @XmlElement(name = "AccessModeList")
    protected AccessModesListOfEnumerations accessModeList;
    @XmlElement(name = "Extension")
    protected Object extension;

    /**
     * Fare authority for which to retrieve Fare information.
     * 
     * Gets the value of the fareAuthorityFilter 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 fareAuthorityFilter property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getFareAuthorityFilter().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link FareAuthorityRefStructure }
     * 
     * 
     * 
     * @return
     *     The value of the fareAuthorityFilter property.
     */
    public List getFareAuthorityFilter() {
        if (fareAuthorityFilter == null) {
            fareAuthorityFilter = new ArrayList<>();
        }
        return this.fareAuthorityFilter;
    }

    /**
     * sequence of all passenger categories, for which this FareProduct is valid
     * 
     * Gets the value of the passengerCategory 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 passengerCategory property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getPassengerCategory().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PassengerCategoryEnumeration }
     * 
     * 
     * 
     * @return
     *     The value of the passengerCategory property.
     */
    public List getPassengerCategory() {
        if (passengerCategory == null) {
            passengerCategory = new ArrayList<>();
        }
        return this.passengerCategory;
    }

    /**
     * Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g., first class). Transmodel: CLASS OF USE.
     * 
     * @return
     *     possible object is
     *     {@link FareClassEnumeration }
     *     
     */
    public FareClassEnumeration getFareClass() {
        return fareClass;
    }

    /**
     * Sets the value of the fareClass property.
     * 
     * @param value
     *     allowed object is
     *     {@link FareClassEnumeration }
     *     
     * @see #getFareClass()
     */
    public void setFareClass(FareClassEnumeration value) {
        this.fareClass = value;
    }

    /**
     * Number of travellers that will make the journey and for which Fare information needs to be gathered.
     * 
     * Gets the value of the traveller 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 traveller property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getTraveller().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link FarePassengerStructure }
     * 
     * 
     * 
     * @return
     *     The value of the traveller property.
     */
    public List getTraveller() {
        if (traveller == null) {
            traveller = new ArrayList<>();
        }
        return this.traveller;
    }

    /**
     * ACCESS MODEs to consider (usually only one). This is only used in very special cases. E.g. for carTransportRail. It indicates if one uses a car, truck, motorcycle or bike. The Access mode may result in no transportation being possible.
     * 
     * @return
     *     possible object is
     *     {@link AccessModesListOfEnumerations }
     *     
     */
    public AccessModesListOfEnumerations getAccessModeList() {
        return accessModeList;
    }

    /**
     * Sets the value of the accessModeList property.
     * 
     * @param value
     *     allowed object is
     *     {@link AccessModesListOfEnumerations }
     *     
     * @see #getAccessModeList()
     */
    public void setAccessModeList(AccessModesListOfEnumerations value) {
        this.accessModeList = value;
    }

    /**
     * Gets the value of the extension property.
     * 
     * @return
     *     possible object is
     *     {@link Object }
     *     
     */
    public Object getExtension() {
        return extension;
    }

    /**
     * Sets the value of the extension property.
     * 
     * @param value
     *     allowed object is
     *     {@link Object }
     *     
     */
    public void setExtension(Object value) {
        this.extension = value;
    }

    public FareParamStructure withFareAuthorityFilter(FareAuthorityRefStructure... values) {
        if (values!= null) {
            for (FareAuthorityRefStructure value: values) {
                getFareAuthorityFilter().add(value);
            }
        }
        return this;
    }

    public FareParamStructure withFareAuthorityFilter(Collection values) {
        if (values!= null) {
            getFareAuthorityFilter().addAll(values);
        }
        return this;
    }

    public FareParamStructure withPassengerCategory(PassengerCategoryEnumeration... values) {
        if (values!= null) {
            for (PassengerCategoryEnumeration value: values) {
                getPassengerCategory().add(value);
            }
        }
        return this;
    }

    public FareParamStructure withPassengerCategory(Collection values) {
        if (values!= null) {
            getPassengerCategory().addAll(values);
        }
        return this;
    }

    public FareParamStructure withFareClass(FareClassEnumeration value) {
        setFareClass(value);
        return this;
    }

    public FareParamStructure withTraveller(FarePassengerStructure... values) {
        if (values!= null) {
            for (FarePassengerStructure value: values) {
                getTraveller().add(value);
            }
        }
        return this;
    }

    public FareParamStructure withTraveller(Collection values) {
        if (values!= null) {
            getTraveller().addAll(values);
        }
        return this;
    }

    public FareParamStructure withAccessModeList(AccessModesListOfEnumerations value) {
        setAccessModeList(value);
        return this;
    }

    public FareParamStructure withExtension(Object value) {
        setExtension(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);
    }

}