de.vdv.ojp20.AlternativeServiceStructure 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.time.Duration;
import de.vdv.ojp20.siri.OperatorRefStructure;
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;


/**
 * Service that provides shared vehicles (The Transmodel MODE OF OPERATION is VEHICLE SHARING; other related Transmodel concepts: ALTERNATIVE MODE LEG.SINGLE JOURNEY.COMMON.VEHICLE SERVICE.TRANSPORT ORGANISATION).
 * 
 * Java class for AlternativeServiceStructure complex type.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * 
 * {@code
 * 
 *   
 *     
 *       
 *         
 *         
 *         
 *         
 *         
 *         
 *       
 *     
 *   
 * 
 * }
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AlternativeServiceStructure", propOrder = {
    "operatorRef",
    "name",
    "timeBufferBefore",
    "timeBufferAfter",
    "infoUrl",
    "restricted",
    "restrictionNote"
})
public class AlternativeServiceStructure {

    /**
     * Identifier of the operator of the sharing service
     * 
     */
    @XmlElement(name = "OperatorRef", required = true)
    protected OperatorRefStructure operatorRef;
    /**
     * Public name of the service.
     * 
     */
    @XmlElement(name = "Name")
    protected String name;
    /**
     * Typical time a user will need  to check in and unlock the vehicle.
     * 
     */
    @XmlElement(name = "TimeBufferBefore", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration timeBufferBefore;
    /**
     * Typical time a user will need  to lock the vehicle and check out.
     * 
     */
    @XmlElement(name = "TimeBufferAfter", type = String.class)
    @XmlJavaTypeAdapter(DurationXmlAdapter.class)
    @XmlSchemaType(name = "duration")
    protected Duration timeBufferAfter;
    /**
     * Link to the web page providing more details on the service.
     * 
     */
    @XmlElement(name = "InfoUrl")
    protected WebLinkStructure infoUrl;
    /**
     * This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles).
     * 
     */
    @XmlElement(name = "Restricted")
    protected Boolean restricted;
    /**
     * Information about the restriction.
     * 
     */
    @XmlElement(name = "RestrictionNote")
    protected InternationalTextStructure restrictionNote;

    /**
     * Identifier of the operator of the sharing service
     * 
     * @return
     *     possible object is
     *     {@link OperatorRefStructure }
     *     
     */
    public OperatorRefStructure getOperatorRef() {
        return operatorRef;
    }

    /**
     * Sets the value of the operatorRef property.
     * 
     * @param value
     *     allowed object is
     *     {@link OperatorRefStructure }
     *     
     * @see #getOperatorRef()
     */
    public void setOperatorRef(OperatorRefStructure value) {
        this.operatorRef = value;
    }

    /**
     * Public name of the service.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the value of the name property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     * @see #getName()
     */
    public void setName(String value) {
        this.name = value;
    }

    /**
     * Typical time a user will need  to check in and unlock the vehicle.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getTimeBufferBefore() {
        return timeBufferBefore;
    }

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

    /**
     * Typical time a user will need  to lock the vehicle and check out.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public Duration getTimeBufferAfter() {
        return timeBufferAfter;
    }

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

    /**
     * Link to the web page providing more details on the service.
     * 
     * @return
     *     possible object is
     *     {@link WebLinkStructure }
     *     
     */
    public WebLinkStructure getInfoUrl() {
        return infoUrl;
    }

    /**
     * Sets the value of the infoUrl property.
     * 
     * @param value
     *     allowed object is
     *     {@link WebLinkStructure }
     *     
     * @see #getInfoUrl()
     */
    public void setInfoUrl(WebLinkStructure value) {
        this.infoUrl = value;
    }

    /**
     * This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g., dragLift) or the LINE is only made available to certain passenger groups (e.g., school buses, hotel shuttles).
     * 
     * @return
     *     possible object is
     *     {@link Boolean }
     *     
     */
    public Boolean isRestricted() {
        return restricted;
    }

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

    /**
     * Information about the restriction.
     * 
     * @return
     *     possible object is
     *     {@link InternationalTextStructure }
     *     
     */
    public InternationalTextStructure getRestrictionNote() {
        return restrictionNote;
    }

    /**
     * Sets the value of the restrictionNote property.
     * 
     * @param value
     *     allowed object is
     *     {@link InternationalTextStructure }
     *     
     * @see #getRestrictionNote()
     */
    public void setRestrictionNote(InternationalTextStructure value) {
        this.restrictionNote = value;
    }

    public AlternativeServiceStructure withOperatorRef(OperatorRefStructure value) {
        setOperatorRef(value);
        return this;
    }

    public AlternativeServiceStructure withName(String value) {
        setName(value);
        return this;
    }

    public AlternativeServiceStructure withTimeBufferBefore(Duration value) {
        setTimeBufferBefore(value);
        return this;
    }

    public AlternativeServiceStructure withTimeBufferAfter(Duration value) {
        setTimeBufferAfter(value);
        return this;
    }

    public AlternativeServiceStructure withInfoUrl(WebLinkStructure value) {
        setInfoUrl(value);
        return this;
    }

    public AlternativeServiceStructure withRestricted(Boolean value) {
        setRestricted(value);
        return this;
    }

    public AlternativeServiceStructure withRestrictionNote(InternationalTextStructure value) {
        setRestrictionNote(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);
    }

}