de.vdv.ojp20.ExchangePointsParamStructure 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 de.vdv.ojp20.siri.ParticipantRefStructure;
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;


/**
 * Java class for ExchangePointsParamStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ExchangePointsParamStructure", propOrder = {
    "type",
    "usage",
    "modes",
    "operatorFilter",
    "topographicPlaceRef",
    "destinationSystem",
    "adjacentSystem",
    "language",
    "numberOfResults",
    "continueAt",
    "extension"
})
public class ExchangePointsParamStructure {

    /**
     * Allowed location/place object types. If none is given, all types are allowed.
     * 
     */
    @XmlElement(name = "Type")
    @XmlSchemaType(name = "string")
    protected List type;
    /**
     * Defines, whether the location/place object of this request acts as origin, via or destination point of the passenger journey.
     * 
     */
    @XmlElement(name = "Usage")
    @XmlSchemaType(name = "string")
    protected PlaceUsageEnumeration usage;
    /**
     * Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops.
     * 
     */
    @XmlElement(name = "Modes")
    protected ModeFilterStructure modes;
    /**
     * Filter for locations/places that are operated by certain organisations.
     * 
     */
    @XmlElement(name = "OperatorFilter")
    protected OperatorFilterStructure operatorFilter;
    /**
     * If at least one is set, only location/place objects within the given localities are allowed.
     * 
     */
    @XmlElement(name = "TopographicPlaceRef")
    protected List topographicPlaceRef;
    /**
     * Reference to system in which the destination (or origin) of the passenger is located.
     * 
     */
    @XmlElement(name = "DestinationSystem")
    protected ParticipantRefStructure destinationSystem;
    /**
     * One or more adjacent systems to which the exchange points should be retrieved.
     * 
     */
    @XmlElement(name = "AdjacentSystem")
    protected List adjacentSystem;
    /**
     * Preferred language in which to return text values.
     * 
     */
    @XmlElement(name = "Language")
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlSchemaType(name = "language")
    protected List language;
    /**
     * Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g., in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response.
     * 
     */
    @XmlElement(name = "NumberOfResults")
    @XmlSchemaType(name = "positiveInteger")
    protected BigInteger numberOfResults;
    /**
     * Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.
     * 
     */
    @XmlElement(name = "ContinueAt")
    @XmlSchemaType(name = "nonNegativeInteger")
    protected BigInteger continueAt;
    @XmlElement(name = "Extension")
    protected Object extension;

    /**
     * Allowed location/place object types. If none is given, all types are allowed.
     * 
     * Gets the value of the type 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 type property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getType().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link PlaceTypeEnumeration }
     * 
     * 
     * 
     * @return
     *     The value of the type property.
     */
    public List getType() {
        if (type == null) {
            type = new ArrayList<>();
        }
        return this.type;
    }

    /**
     * Defines, whether the location/place object of this request acts as origin, via or destination point of the passenger journey.
     * 
     * @return
     *     possible object is
     *     {@link PlaceUsageEnumeration }
     *     
     */
    public PlaceUsageEnumeration getUsage() {
        return usage;
    }

    /**
     * Sets the value of the usage property.
     * 
     * @param value
     *     allowed object is
     *     {@link PlaceUsageEnumeration }
     *     
     * @see #getUsage()
     */
    public void setUsage(PlaceUsageEnumeration value) {
        this.usage = value;
    }

    /**
     * Allowed public transport modes. Defines, which public transport modes must be available at the returned location/place objects. Applies only to stops.
     * 
     * @return
     *     possible object is
     *     {@link ModeFilterStructure }
     *     
     */
    public ModeFilterStructure getModes() {
        return modes;
    }

    /**
     * Sets the value of the modes property.
     * 
     * @param value
     *     allowed object is
     *     {@link ModeFilterStructure }
     *     
     * @see #getModes()
     */
    public void setModes(ModeFilterStructure value) {
        this.modes = value;
    }

    /**
     * Filter for locations/places that are operated by certain organisations.
     * 
     * @return
     *     possible object is
     *     {@link OperatorFilterStructure }
     *     
     */
    public OperatorFilterStructure getOperatorFilter() {
        return operatorFilter;
    }

    /**
     * Sets the value of the operatorFilter property.
     * 
     * @param value
     *     allowed object is
     *     {@link OperatorFilterStructure }
     *     
     * @see #getOperatorFilter()
     */
    public void setOperatorFilter(OperatorFilterStructure value) {
        this.operatorFilter = value;
    }

    /**
     * If at least one is set, only location/place objects within the given localities are allowed.
     * 
     * Gets the value of the topographicPlaceRef 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 topographicPlaceRef property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getTopographicPlaceRef().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link TopographicPlaceRefStructure }
     * 
     * 
     * 
     * @return
     *     The value of the topographicPlaceRef property.
     */
    public List getTopographicPlaceRef() {
        if (topographicPlaceRef == null) {
            topographicPlaceRef = new ArrayList<>();
        }
        return this.topographicPlaceRef;
    }

    /**
     * Reference to system in which the destination (or origin) of the passenger is located.
     * 
     * @return
     *     possible object is
     *     {@link ParticipantRefStructure }
     *     
     */
    public ParticipantRefStructure getDestinationSystem() {
        return destinationSystem;
    }

    /**
     * Sets the value of the destinationSystem property.
     * 
     * @param value
     *     allowed object is
     *     {@link ParticipantRefStructure }
     *     
     * @see #getDestinationSystem()
     */
    public void setDestinationSystem(ParticipantRefStructure value) {
        this.destinationSystem = value;
    }

    /**
     * One or more adjacent systems to which the exchange points should be retrieved.
     * 
     * Gets the value of the adjacentSystem 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 adjacentSystem property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getAdjacentSystem().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link ParticipantRefStructure }
     * 
     * 
     * 
     * @return
     *     The value of the adjacentSystem property.
     */
    public List getAdjacentSystem() {
        if (adjacentSystem == null) {
            adjacentSystem = new ArrayList<>();
        }
        return this.adjacentSystem;
    }

    /**
     * Preferred language in which to return text values.
     * 
     * Gets the value of the language 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 language property.
     * 
     * 
     * For example, to add a new item, do as follows:
     * 
     *      * getLanguage().add(newItem);
     * 
     * 
     * 
     * 
     * Objects of the following type(s) are allowed in the list
     * {@link String }
     * 
     * 
     * 
     * @return
     *     The value of the language property.
     */
    public List getLanguage() {
        if (language == null) {
            language = new ArrayList<>();
        }
        return this.language;
    }

    /**
     * Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g., in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getNumberOfResults() {
        return numberOfResults;
    }

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

    /**
     * Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.
     * 
     * @return
     *     possible object is
     *     {@link BigInteger }
     *     
     */
    public BigInteger getContinueAt() {
        return continueAt;
    }

    /**
     * Sets the value of the continueAt property.
     * 
     * @param value
     *     allowed object is
     *     {@link BigInteger }
     *     
     * @see #getContinueAt()
     */
    public void setContinueAt(BigInteger value) {
        this.continueAt = 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 ExchangePointsParamStructure withType(PlaceTypeEnumeration... values) {
        if (values!= null) {
            for (PlaceTypeEnumeration value: values) {
                getType().add(value);
            }
        }
        return this;
    }

    public ExchangePointsParamStructure withType(Collection values) {
        if (values!= null) {
            getType().addAll(values);
        }
        return this;
    }

    public ExchangePointsParamStructure withUsage(PlaceUsageEnumeration value) {
        setUsage(value);
        return this;
    }

    public ExchangePointsParamStructure withModes(ModeFilterStructure value) {
        setModes(value);
        return this;
    }

    public ExchangePointsParamStructure withOperatorFilter(OperatorFilterStructure value) {
        setOperatorFilter(value);
        return this;
    }

    public ExchangePointsParamStructure withTopographicPlaceRef(TopographicPlaceRefStructure... values) {
        if (values!= null) {
            for (TopographicPlaceRefStructure value: values) {
                getTopographicPlaceRef().add(value);
            }
        }
        return this;
    }

    public ExchangePointsParamStructure withTopographicPlaceRef(Collection values) {
        if (values!= null) {
            getTopographicPlaceRef().addAll(values);
        }
        return this;
    }

    public ExchangePointsParamStructure withDestinationSystem(ParticipantRefStructure value) {
        setDestinationSystem(value);
        return this;
    }

    public ExchangePointsParamStructure withAdjacentSystem(ParticipantRefStructure... values) {
        if (values!= null) {
            for (ParticipantRefStructure value: values) {
                getAdjacentSystem().add(value);
            }
        }
        return this;
    }

    public ExchangePointsParamStructure withAdjacentSystem(Collection values) {
        if (values!= null) {
            getAdjacentSystem().addAll(values);
        }
        return this;
    }

    public ExchangePointsParamStructure withLanguage(String... values) {
        if (values!= null) {
            for (String value: values) {
                getLanguage().add(value);
            }
        }
        return this;
    }

    public ExchangePointsParamStructure withLanguage(Collection values) {
        if (values!= null) {
            getLanguage().addAll(values);
        }
        return this;
    }

    public ExchangePointsParamStructure withNumberOfResults(BigInteger value) {
        setNumberOfResults(value);
        return this;
    }

    public ExchangePointsParamStructure withContinueAt(BigInteger value) {
        setContinueAt(value);
        return this;
    }

    public ExchangePointsParamStructure 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);
    }

}