com.adyen.model.nexo.CustomerOrder Maven / Gradle / Ivy

Go to download
package com.adyen.model.nexo;

import io.swagger.v3.oas.annotations.media.Schema;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.datatype.XMLGregorianCalendar;
import java.math.BigDecimal;


/**
 * Definition: Customer order attached to a card, recorded in the POI system. -- Usage: Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.
 *
 * Java class for CustomerOrder complex type.
 *
 * 
The following schema fragment specifies the expected content contained within this class.
 *
 * 
 * <complexType name="CustomerOrder">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element name="AdditionalInformation" type="{}AdditionalInformation" minOccurs="0"/>
 *       </sequence>
 *       <attribute name="CustomerOrderID" use="required" type="{}CustomerOrderID" />
 *       <attribute name="OpenOrderState" type="{}OpenOrderState" default="false" />
 *       <attribute name="StartDate" use="required" type="{}StartDate" />
 *       <attribute name="EndDate" type="{}EndDate" />
 *       <attribute name="ForecastedAmount" use="required" type="{}SimpleAmountType" />
 *       <attribute name="CurrentAmount" use="required" type="{}SimpleAmountType" />
 *       <attribute name="Currency" type="{}ISOCurrency3A" />
 *       <attribute name="AccessedBy" type="{}AccessedBy" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CustomerOrder", propOrder = {
        "additionalInformation"
})
public class CustomerOrder {

    /**
     * The Additional information.
     */
    @XmlElement(name = "AdditionalInformation")
    @Schema(description = "Unqualified information. --Rule: If order process in progress.")
    protected String additionalInformation;
    /**
     * The Customer order id.
     */
    @XmlElement(name = "CustomerOrderID", required = true)
    @Schema(description = "Identification of a customer order.")
    protected String customerOrderID;
    /**
     * The Open order state.
     */
    @XmlElement(name = "OpenOrderState")
    @Schema(description = "State of a customer order.")
    protected Boolean openOrderState;
    /**
     * The Start date.
     */
    @XmlElement(name = "StartDate", required = true)
    @Schema(description = "Date time of the beginning of an operation.")
    protected XMLGregorianCalendar startDate;
    /**
     * The End date.
     */
    @XmlElement(name = "EndDate")
    @Schema(description = "Date time of the end of an operation. --Rule: If ClosedOrderFlag = \"True\".")
    protected XMLGregorianCalendar endDate;
    /**
     * The Forecasted amount.
     */
    @XmlElement(name = "ForecastedAmount", required = true)
    @Schema(description = "Amount of a transaction.")
    protected BigDecimal forecastedAmount;
    /**
     * The Current amount.
     */
    @XmlElement(name = "CurrentAmount", required = true)
    @Schema(description = "Remaining amount to pay in a transaction.")
    protected BigDecimal currentAmount;
    /**
     * The Currency.
     */
    @XmlElement(name = "Currency")
    @Schema(description = "Currency of a monetary amount.")
    protected String currency;
    /**
     * The Accessed by.
     */
    @XmlElement(name = "AccessedBy")
    @Schema(description = "Identification of an entity accessing data to perform an operation. --Rule: If multiple currencies are allowed.")
    protected String accessedBy;

    /**
     * Gets the value of the additionalInformation property.
     *
     * @return possible      object is     {@link String }
     */
    public String getAdditionalInformation() {
        return additionalInformation;
    }

    /**
     * Sets the value of the additionalInformation property.
     *
     * @param value allowed object is     {@link String }
     */
    public void setAdditionalInformation(String value) {
        this.additionalInformation = value;
    }

    /**
     * Gets the value of the customerOrderID property.
     *
     * @return possible      object is     {@link String }
     */
    public String getCustomerOrderID() {
        return customerOrderID;
    }

    /**
     * Sets the value of the customerOrderID property.
     *
     * @param value allowed object is     {@link String }
     */
    public void setCustomerOrderID(String value) {
        this.customerOrderID = value;
    }

    /**
     * Gets the value of the openOrderState property.
     *
     * @return possible      object is     {@link Boolean }
     */
    public boolean isOpenOrderState() {
        if (openOrderState == null) {
            return false;
        } else {
            return openOrderState;
        }
    }

    /**
     * Sets the value of the openOrderState property.
     *
     * @param value allowed object is     {@link Boolean }
     */
    public void setOpenOrderState(Boolean value) {
        this.openOrderState = value;
    }

    /**
     * Gets the value of the startDate property.
     *
     * @return possible      object is     {@link XMLGregorianCalendar }
     */
    public XMLGregorianCalendar getStartDate() {
        return startDate;
    }

    /**
     * Sets the value of the startDate property.
     *
     * @param value allowed object is     {@link XMLGregorianCalendar }
     */
    public void setStartDate(XMLGregorianCalendar value) {
        this.startDate = value;
    }

    /**
     * Gets the value of the endDate property.
     *
     * @return possible      object is     {@link XMLGregorianCalendar }
     */
    public XMLGregorianCalendar getEndDate() {
        return endDate;
    }

    /**
     * Sets the value of the endDate property.
     *
     * @param value allowed object is     {@link XMLGregorianCalendar }
     */
    public void setEndDate(XMLGregorianCalendar value) {
        this.endDate = value;
    }

    /**
     * Gets the value of the forecastedAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getForecastedAmount() {
        return forecastedAmount;
    }

    /**
     * Sets the value of the forecastedAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setForecastedAmount(BigDecimal value) {
        this.forecastedAmount = value;
    }

    /**
     * Gets the value of the currentAmount property.
     *
     * @return possible      object is     {@link BigDecimal }
     */
    public BigDecimal getCurrentAmount() {
        return currentAmount;
    }

    /**
     * Sets the value of the currentAmount property.
     *
     * @param value allowed object is     {@link BigDecimal }
     */
    public void setCurrentAmount(BigDecimal value) {
        this.currentAmount = value;
    }

    /**
     * Gets the value of the currency property.
     *
     * @return possible      object is     {@link String }
     */
    public String getCurrency() {
        return currency;
    }

    /**
     * Sets the value of the currency property.
     *
     * @param value allowed object is     {@link String }
     */
    public void setCurrency(String value) {
        this.currency = value;
    }

    /**
     * Gets the value of the accessedBy property.
     *
     * @return possible      object is     {@link String }
     */
    public String getAccessedBy() {
        return accessedBy;
    }

    /**
     * Sets the value of the accessedBy property.
     *
     * @param value allowed object is     {@link String }
     */
    public void setAccessedBy(String value) {
        this.accessedBy = value;
    }

}