de.vdv.ojp20.StopEventParamStructure 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.time.Duration;
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.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;
import org.opentripplanner.ojp.util.DurationXmlAdapter;


/**
 * Request specific parameters (parameters which define what is to be included in a Stop  Event result)
 * 
 * Java class for StopEventParamStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "StopEventParamStructure", propOrder = {
    "modeFilter",
    "lineFilter",
    "operatorFilter",
    "includeAllRestrictedLines",
    "numberOfResults",
    "timeWindow",
    "stopEventType",
    "includePreviousCalls",
    "includeOnwardCalls",
    "includeOperatingDays",
    "useRealtimeData",
    "includePlacesContext",
    "includeSituationsContext",
    "includeStopHierarchy",
    "extension"
})
public class StopEventParamStructure {

    /**
     * MODEs to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service.
     * 
     */
    @XmlElement(name = "ModeFilter")
    protected ModeFilterStructure modeFilter;
    /**
     * Lines/Directions to include/exclude.
     * 
     */
    @XmlElement(name = "LineFilter")
    protected LineDirectionFilterStructure lineFilter;
    /**
     * Transport operators to include/exclude.
     * 
     */
    @XmlElement(name = "OperatorFilter")
    protected OperatorFilterStructure operatorFilter;
    /**
     * There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements.
     * 
     */
    @XmlElement(name = "IncludeAllRestrictedLines", defaultValue = "false")
    protected Boolean includeAllRestrictedLines;
    /**
     * parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set
     * 
     */
    @XmlElement(name = "NumberOfResults")
    @XmlSchemaType(name = "positiveInteger")
    protected BigInteger numberOfResults;
    /**
     * Time window events should lie within. Starting from time given in PlaceContext.
     * 
     */
    @XmlElement(name = "TimeWindow", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration timeWindow;
    /**
     * Only departures or arrivals or both.
     * 
     */
    @XmlElement(name = "StopEventType")
    @XmlSchemaType(name = "string")
    protected StopEventTypeEnumeration stopEventType;
    /**
     * Whether the previous calls of each vehicle journey should be included in the response.
     * 
     */
    @XmlElement(name = "IncludePreviousCalls", defaultValue = "false")
    protected Boolean includePreviousCalls;
    /**
     * Whether the onward calls of each vehicle journey should be included in the response.
     * 
     */
    @XmlElement(name = "IncludeOnwardCalls", defaultValue = "false")
    protected Boolean includeOnwardCalls;
    /**
     * Whether operating day information of this stop event should be included in the response.
     * 
     */
    @XmlElement(name = "IncludeOperatingDays", defaultValue = "false")
    protected Boolean includeOperatingDays;
    /**
     * Whether real-time information of this stop event should be used in the response. Default is "full"
     * 
     */
    @XmlElement(name = "UseRealtimeData", defaultValue = "full")
    @XmlSchemaType(name = "string")
    protected UseRealtimeDataEnumeration useRealtimeData;
    /**
     * Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.
     * 
     */
    @XmlElement(name = "IncludePlacesContext", defaultValue = "true")
    protected Boolean includePlacesContext;
    /**
     * Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true
     * 
     */
    @XmlElement(name = "IncludeSituationsContext", defaultValue = "true")
    protected Boolean includeSituationsContext;
    /**
     * Indicates for which parts of the hierarchy of the StopPlace(s) stop events should 
     * 					be provided (if known by the server). "local" (default) is the local server setting. "no" will include
     * 					no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/
     * 					StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces 
     * 					for the meta station if it is known. How to use this: if you indicate the reference to a train station 
     * 					and the parameter is set to "down", the departures/arrivals at the associated bus stations will show as 
     * 					well. If you have the ScheduledStopPoint of platform B of the local bus and it is associated with 3 other 
     * 					stations, you will get all these arrivals/departures as well if the parameter is set to "all".
     * 
     */
    @XmlElement(name = "IncludeStopHierarchy", defaultValue = "local")
    @XmlSchemaType(name = "NMTOKEN")
    protected HierarchyEnumeration includeStopHierarchy;
    @XmlElement(name = "Extension")
    protected Object extension;

    /**
     * MODEs to be excluded or included in stop events. We on purpose don't use ModeOfOperationFilter in the stop event service.
     * 
     * @return
     *     possible object is
     *     {@link ModeFilterStructure }
     *     
     */
    public ModeFilterStructure getModeFilter() {
        return modeFilter;
    }

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

    /**
     * Lines/Directions to include/exclude.
     * 
     * @return
     *     possible object is
     *     {@link LineDirectionFilterStructure }
     *     
     */
    public LineDirectionFilterStructure getLineFilter() {
        return lineFilter;
    }

    /**
     * Sets the value of the lineFilter property.
     * 
     * @param value
     *     allowed object is
     *     {@link LineDirectionFilterStructure }
     *     
     * @see #getLineFilter()
     */
    public void setLineFilter(LineDirectionFilterStructure value) {
        this.lineFilter = value;
    }

    /**
     * Transport operators to include/exclude.
     * 
     * @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;
    }

    /**
     * There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isIncludeAllRestrictedLines() {
        return includeAllRestrictedLines;
    }

    /**
     * Sets the value of the includeAllRestrictedLines property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isIncludeAllRestrictedLines()
     */
    public void setIncludeAllRestrictedLines(Boolean value) {
        this.includeAllRestrictedLines = value;
    }

    /**
     * parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set
     * 
     * @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;
    }

    /**
     * Time window events should lie within. Starting from time given in PlaceContext.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getTimeWindow() {
        return timeWindow;
    }

    /**
     * Sets the value of the timeWindow property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getTimeWindow()
     */
    public void setTimeWindow(Duration value) {
        this.timeWindow = value;
    }

    /**
     * Only departures or arrivals or both.
     * 
     * @return
     *     possible object is
     *     {@link StopEventTypeEnumeration }
     *     
     */
    public StopEventTypeEnumeration getStopEventType() {
        return stopEventType;
    }

    /**
     * Sets the value of the stopEventType property.
     * 
     * @param value
     *     allowed object is
     *     {@link StopEventTypeEnumeration }
     *     
     * @see #getStopEventType()
     */
    public void setStopEventType(StopEventTypeEnumeration value) {
        this.stopEventType = value;
    }

    /**
     * Whether the previous calls of each vehicle journey should be included in the response.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isIncludePreviousCalls() {
        return includePreviousCalls;
    }

    /**
     * Sets the value of the includePreviousCalls property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isIncludePreviousCalls()
     */
    public void setIncludePreviousCalls(Boolean value) {
        this.includePreviousCalls = value;
    }

    /**
     * Whether the onward calls of each vehicle journey should be included in the response.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isIncludeOnwardCalls() {
        return includeOnwardCalls;
    }

    /**
     * Sets the value of the includeOnwardCalls property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isIncludeOnwardCalls()
     */
    public void setIncludeOnwardCalls(Boolean value) {
        this.includeOnwardCalls = value;
    }

    /**
     * Whether operating day information of this stop event should be included in the response.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isIncludeOperatingDays() {
        return includeOperatingDays;
    }

    /**
     * Sets the value of the includeOperatingDays property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isIncludeOperatingDays()
     */
    public void setIncludeOperatingDays(Boolean value) {
        this.includeOperatingDays = value;
    }

    /**
     * Whether real-time information of this stop event should be used in the response. Default is "full"
     * 
     * @return
     *     possible object is
     *     {@link UseRealtimeDataEnumeration }
     *     
     */
    public UseRealtimeDataEnumeration getUseRealtimeData() {
        return useRealtimeData;
    }

    /**
     * Sets the value of the useRealtimeData property.
     * 
     * @param value
     *     allowed object is
     *     {@link UseRealtimeDataEnumeration }
     *     
     * @see #getUseRealtimeData()
     */
    public void setUseRealtimeData(UseRealtimeDataEnumeration value) {
        this.useRealtimeData = value;
    }

    /**
     * Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isIncludePlacesContext() {
        return includePlacesContext;
    }

    /**
     * Sets the value of the includePlacesContext property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isIncludePlacesContext()
     */
    public void setIncludePlacesContext(Boolean value) {
        this.includePlacesContext = value;
    }

    /**
     * Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isIncludeSituationsContext() {
        return includeSituationsContext;
    }

    /**
     * Sets the value of the includeSituationsContext property.
     * 
     * @param value
     *     allowed object is
     *     {@link Boolean }
     *     
     * @see #isIncludeSituationsContext()
     */
    public void setIncludeSituationsContext(Boolean value) {
        this.includeSituationsContext = value;
    }

    /**
     * Indicates for which parts of the hierarchy of the StopPlace(s) stop events should 
     * 					be provided (if known by the server). "local" (default) is the local server setting. "no" will include
     * 					no hierarchy and only provide the given StopPlace / StopPoint. "down" will include all lower StopPoints/
     * 					StopPlaces in the hierarchy, if such a hierarchy exists. "all" does include all StopPoints/StopPlaces 
     * 					for the meta station if it is known. How to use this: if you indicate the reference to a train station 
     * 					and the parameter is set to "down", the departures/arrivals at the associated bus stations will show as 
     * 					well. If you have the ScheduledStopPoint of platform B of the local bus and it is associated with 3 other 
     * 					stations, you will get all these arrivals/departures as well if the parameter is set to "all".
     * 
     * @return
     *     possible object is
     *     {@link HierarchyEnumeration }
     *     
     */
    public HierarchyEnumeration getIncludeStopHierarchy() {
        return includeStopHierarchy;
    }

    /**
     * Sets the value of the includeStopHierarchy property.
     * 
     * @param value
     *     allowed object is
     *     {@link HierarchyEnumeration }
     *     
     * @see #getIncludeStopHierarchy()
     */
    public void setIncludeStopHierarchy(HierarchyEnumeration value) {
        this.includeStopHierarchy = 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 StopEventParamStructure withModeFilter(ModeFilterStructure value) {
        setModeFilter(value);
        return this;
    }

    public StopEventParamStructure withLineFilter(LineDirectionFilterStructure value) {
        setLineFilter(value);
        return this;
    }

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

    public StopEventParamStructure withIncludeAllRestrictedLines(Boolean value) {
        setIncludeAllRestrictedLines(value);
        return this;
    }

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

    public StopEventParamStructure withTimeWindow(Duration value) {
        setTimeWindow(value);
        return this;
    }

    public StopEventParamStructure withStopEventType(StopEventTypeEnumeration value) {
        setStopEventType(value);
        return this;
    }

    public StopEventParamStructure withIncludePreviousCalls(Boolean value) {
        setIncludePreviousCalls(value);
        return this;
    }

    public StopEventParamStructure withIncludeOnwardCalls(Boolean value) {
        setIncludeOnwardCalls(value);
        return this;
    }

    public StopEventParamStructure withIncludeOperatingDays(Boolean value) {
        setIncludeOperatingDays(value);
        return this;
    }

    public StopEventParamStructure withUseRealtimeData(UseRealtimeDataEnumeration value) {
        setUseRealtimeData(value);
        return this;
    }

    public StopEventParamStructure withIncludePlacesContext(Boolean value) {
        setIncludePlacesContext(value);
        return this;
    }

    public StopEventParamStructure withIncludeSituationsContext(Boolean value) {
        setIncludeSituationsContext(value);
        return this;
    }

    public StopEventParamStructure withIncludeStopHierarchy(HierarchyEnumeration value) {
        setIncludeStopHierarchy(value);
        return this;
    }

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

}