de.vdv.ojp20.OJPMultiPointTripRequestStructure Maven / Gradle / Ivy
Show all versions of ojp-java-model Show documentation
//
// 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.DataFrameRefStructure;
import de.vdv.ojp20.siri.ExtensionsStructure;
import de.vdv.ojp20.siri.MessageQualifierStructure;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;
import org.opentripplanner.ojp.time.XmlDateTime;
/**
* Java class for OJPMultiPointTripRequestStructure complex type
.
*
* The following schema fragment specifies the expected content contained within this class.
*
* {@code
*
*
*
*
*
*
*
*
* }
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "OJPMultiPointTripRequestStructure", propOrder = {
"origin",
"destination",
"via",
"notVia",
"noChangeAt",
"params",
"extensions"
})
public class OJPMultiPointTripRequestStructure
extends AbstractOJPServiceRequestStructure
{
/**
* Specifies the origin situation from where the user wants to start.
*
*/
@XmlElement(name = "Origin", required = true)
protected List origin;
/**
* Specifies the destination situation where the user is heading to.
*
*/
@XmlElement(name = "Destination", required = true)
protected List destination;
/**
* Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia).
*
*/
@XmlElement(name = "Via")
protected List via;
/**
* Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.
*
*/
@XmlElement(name = "NotVia")
protected List notVia;
/**
* no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP (in Transmodel this would be an extension to TRIP MOBILITY FILTER).
*
*/
@XmlElement(name = "NoChangeAt")
protected List noChangeAt;
/**
* Options to control the search behaviour and response contents.
*
*/
@XmlElement(name = "Params")
protected MultiPointTripParamStructure params;
@XmlElement(name = "Extensions", namespace = "http://www.siri.org.uk/siri")
protected ExtensionsStructure extensions;
/**
* Specifies the origin situation from where the user wants to start.
*
* Gets the value of the origin 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 origin property.
*
*
* For example, to add a new item, do as follows:
*
*
* getOrigin().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PlaceContextStructure }
*
*
*
* @return
* The value of the origin property.
*/
public List getOrigin() {
if (origin == null) {
origin = new ArrayList<>();
}
return this.origin;
}
/**
* Specifies the destination situation where the user is heading to.
*
* Gets the value of the destination 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 destination property.
*
*
* For example, to add a new item, do as follows:
*
*
* getDestination().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PlaceContextStructure }
*
*
*
* @return
* The value of the destination property.
*/
public List getDestination() {
if (destination == null) {
destination = new ArrayList<>();
}
return this.destination;
}
/**
* Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops (in Transmodel modelled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia).
*
* Gets the value of the via 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 via property.
*
*
* For example, to add a new item, do as follows:
*
*
* getVia().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link TripViaStructure }
*
*
*
* @return
* The value of the via property.
*/
public List getVia() {
if (via == null) {
via = new ArrayList<>();
}
return this.via;
}
/**
* Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through. If more than one not via point is given all of them must be obeyed.
*
* Gets the value of the notVia 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 notVia property.
*
*
* For example, to add a new item, do as follows:
*
*
* getNotVia().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link NotViaStructure }
*
*
*
* @return
* The value of the notVia property.
*/
public List getNotVia() {
if (notVia == null) {
notVia = new ArrayList<>();
}
return this.notVia;
}
/**
* no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP (in Transmodel this would be an extension to TRIP MOBILITY FILTER).
*
* Gets the value of the noChangeAt 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 noChangeAt property.
*
*
* For example, to add a new item, do as follows:
*
*
* getNoChangeAt().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link NoChangeAtStructure }
*
*
*
* @return
* The value of the noChangeAt property.
*/
public List getNoChangeAt() {
if (noChangeAt == null) {
noChangeAt = new ArrayList<>();
}
return this.noChangeAt;
}
/**
* Options to control the search behaviour and response contents.
*
* @return
* possible object is
* {@link MultiPointTripParamStructure }
*
*/
public MultiPointTripParamStructure getParams() {
return params;
}
/**
* Sets the value of the params property.
*
* @param value
* allowed object is
* {@link MultiPointTripParamStructure }
*
* @see #getParams()
*/
public void setParams(MultiPointTripParamStructure value) {
this.params = value;
}
/**
* Gets the value of the extensions property.
*
* @return
* possible object is
* {@link ExtensionsStructure }
*
*/
public ExtensionsStructure getExtensions() {
return extensions;
}
/**
* Sets the value of the extensions property.
*
* @param value
* allowed object is
* {@link ExtensionsStructure }
*
*/
public void setExtensions(ExtensionsStructure value) {
this.extensions = value;
}
public OJPMultiPointTripRequestStructure withOrigin(PlaceContextStructure... values) {
if (values!= null) {
for (PlaceContextStructure value: values) {
getOrigin().add(value);
}
}
return this;
}
public OJPMultiPointTripRequestStructure withOrigin(Collection values) {
if (values!= null) {
getOrigin().addAll(values);
}
return this;
}
public OJPMultiPointTripRequestStructure withDestination(PlaceContextStructure... values) {
if (values!= null) {
for (PlaceContextStructure value: values) {
getDestination().add(value);
}
}
return this;
}
public OJPMultiPointTripRequestStructure withDestination(Collection values) {
if (values!= null) {
getDestination().addAll(values);
}
return this;
}
public OJPMultiPointTripRequestStructure withVia(TripViaStructure... values) {
if (values!= null) {
for (TripViaStructure value: values) {
getVia().add(value);
}
}
return this;
}
public OJPMultiPointTripRequestStructure withVia(Collection values) {
if (values!= null) {
getVia().addAll(values);
}
return this;
}
public OJPMultiPointTripRequestStructure withNotVia(NotViaStructure... values) {
if (values!= null) {
for (NotViaStructure value: values) {
getNotVia().add(value);
}
}
return this;
}
public OJPMultiPointTripRequestStructure withNotVia(Collection values) {
if (values!= null) {
getNotVia().addAll(values);
}
return this;
}
public OJPMultiPointTripRequestStructure withNoChangeAt(NoChangeAtStructure... values) {
if (values!= null) {
for (NoChangeAtStructure value: values) {
getNoChangeAt().add(value);
}
}
return this;
}
public OJPMultiPointTripRequestStructure withNoChangeAt(Collection values) {
if (values!= null) {
getNoChangeAt().addAll(values);
}
return this;
}
public OJPMultiPointTripRequestStructure withParams(MultiPointTripParamStructure value) {
setParams(value);
return this;
}
public OJPMultiPointTripRequestStructure withExtensions(ExtensionsStructure value) {
setExtensions(value);
return this;
}
@Override
public OJPMultiPointTripRequestStructure withDataFrameRef(DataFrameRefStructure value) {
setDataFrameRef(value);
return this;
}
@Override
public OJPMultiPointTripRequestStructure withExtension(Object value) {
setExtension(value);
return this;
}
@Override
public OJPMultiPointTripRequestStructure withMessageIdentifier(MessageQualifierStructure value) {
setMessageIdentifier(value);
return this;
}
@Override
public OJPMultiPointTripRequestStructure withRequestTimestamp(XmlDateTime value) {
setRequestTimestamp(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);
}
}