com.omgm.speedy.eps.soap.model.ParamOrder Maven / Gradle / Ivy
package com.omgm.speedy.eps.soap.model;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.datatype.XMLGregorianCalendar;
/**
* Java class for paramOrder complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="paramOrder">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="billOfLadingsList" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
* <element name="billOfLadingsToIncludeType" type="{http://www.w3.org/2001/XMLSchema}int"/>
* <element name="contactName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="phoneNumber" type="{http://ver01.eps.speedy.sirma.com/}paramPhoneNumber" minOccurs="0"/>
* <element name="pickupDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
* <element name="readinessTime" type="{http://www.w3.org/2001/XMLSchema}short" minOccurs="0"/>
* <element name="workingEndTime" type="{http://www.w3.org/2001/XMLSchema}short" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
* Instances of this class are used as parameters for orders web service calls
*
* @since 1.0.0
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "paramOrder", propOrder = {
"billOfLadingsList",
"billOfLadingsToIncludeType",
"contactName",
"phoneNumber",
"pickupDate",
"readinessTime",
"workingEndTime"
})
public class ParamOrder {
/**
* List of BOL numbers.
* MANDATORY: Must be set <=> billOfLadingsToIncludeType = 10.
*/
@XmlElement(nillable = true)
protected List billOfLadingsList;
/**
* Specifies the set of shipments/BOLs to be ordered:
* •[10] Explicit numbers (in billOfLadingsList)
* •[20] All not-ordered-yet BOLs created by the logged client
* •[30] All not-ordered-yet BOLs created by the logged client or members of his/her contract (taking into account user's permissions)
* MANDATORY: YES
*/
protected int billOfLadingsToIncludeType;
/**
* Contact name.
* Limited to 60 symbols.
* MANDATORY: YES
*/
protected String contactName;
/**
* Phone number
* MANDATORY: YES
*/
protected ParamPhoneNumber phoneNumber;
/**
* The date for shipments pick-up (the "time" component is ignored). The default value is "today".
* MANDATORY: NO
*/
@XmlSchemaType(name = "dateTime")
protected XMLGregorianCalendar pickupDate;
/**
* Specifies when all the shipments/parcels will be ready for pickup. The default value is "now".
* MANDATORY: Only if pickupDate > today
*/
protected Short readinessTime;
/**
* The sender's working time end
* MANDATORY: YES
*/
protected Short workingEndTime;
/**
* Gets the bill of ladings list.
* List of BOL numbers.
* Must be set when billOfLadingsToIncludeType = 10.
*
*
* 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 billOfLadingsList property.
*
*
* For example, to add a new item, do as follows:
*
* getBillOfLadingsList().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Long }
*
*
*/
public List getBillOfLadingsList() {
if (billOfLadingsList == null) {
billOfLadingsList = new ArrayList();
}
return this.billOfLadingsList;
}
/**
* Gets the code for the set of bill of ladings to order
* @return Code for the set of bill of ladings to order
*/
public int getBillOfLadingsToIncludeType() {
return billOfLadingsToIncludeType;
}
/**
* Sets the billOfLadingsToIncludeType.
* Specifies the set of shipments/BOLs to be ordered:
* •[10] Explicit numbers (in billOfLadingsList)
* •[20] All not-ordered-yet BOLs created by the logged client
* •[30] All not-ordered-yet BOLs created by the logged client or members of his/her contract (taking into account user's permissions)
* @param billOfLadingsToIncludeType Code for the set of bill of ladings to order
*/
public void setBillOfLadingsToIncludeType(int billOfLadingsToIncludeType) {
this.billOfLadingsToIncludeType = billOfLadingsToIncludeType;
}
/**
* Gets the contact name.
* @return Contact name
*/
public String getContactName() {
return contactName;
}
/**
* Sets the contact name.
* Limited to 60 symbols
* @param contactName Contact name
*/
public void setContactName(String contactName) {
this.contactName = contactName;
}
/**
* Gets the phone number
* @return Phone number
*/
public ParamPhoneNumber getPhoneNumber() {
return phoneNumber;
}
/**
* Sets the phone number
* @param phoneNumber Phone number
*/
public void setPhoneNumber(ParamPhoneNumber phoneNumber) {
this.phoneNumber = phoneNumber;
}
/**
* Gets the pickup date
* @return The date for shipments pick-up (the "time" component is ignored).
*/
public XMLGregorianCalendar getPickupDate() {
return pickupDate;
}
/**
* Sets the pickup date.
* The date for shipments pick-up (the "time" component is ignored). The default value is "today".
* @param pickupDate Pickup date
*/
public void setPickupDate(XMLGregorianCalendar pickupDate) {
this.pickupDate = pickupDate;
}
/**
* Gets the readiness time - when all the shipments/parcels will be ready for pickup.
* Format is "HHmm"
* @return When all the shipments/parcels will be ready for pickup.
*/
public Short getReadinessTime() {
return readinessTime;
}
/**
* Sets the readiness time.
* Specifies when all the shipments/parcels will be ready for pickup. The default value is "now".
* Must be set if pickupDate > today
* Format is "HHmm".
* @param readinessTime The time the shipments/parcels will be ready for pickup
*/
public void setReadinessTime(Short readinessTime) {
this.readinessTime = readinessTime;
}
/**
* Gets the sender's working time end
* @return The sender's working time end
*/
public Short getWorkingEndTime() {
return workingEndTime;
}
/**
* Sets the sender's working time end.
* Format is "HHmm"
* @param workingEndTime
*/
public void setWorkingEndTime(Short workingEndTime) {
this.workingEndTime = workingEndTime;
}
}