public class FShipSummary extends APIParam<FShipSummary>
| Modifier and Type | Field and Description |
|---|---|
protected java.util.ArrayList<FOrderDetail> |
ivShipDtls
The shipment's collection of shipment details.
|
private static long |
serialVersionUID
The class' serialization version id.
|
ivHashCode, ivHashFlds, ivObjFlds| Constructor and Description |
|---|
FShipSummary()
Constructs a
FShipSummary object with all field values set to
null. |
FShipSummary(java.util.HashMap<java.lang.String,java.lang.Object> source)
Constructs a
FShipSummary object with field values based on the
supplied hash map. |
FShipSummary(java.lang.String source)
Constructs a
FShipSummary object with field values based on the
supplied JSON text string. |
| Modifier and Type | Method and Description |
|---|---|
void |
addTrackingNum(java.lang.String track)
Adds a shipment tracking number to the
String collection. |
java.lang.String |
fmtShiptoAddress()
Returns the ship-to customer's entire address in a format suitable for
display on a web page.
|
java.lang.String |
fmtShiptoAddress(java.lang.String lineSeparator)
Returns the ship-to customer's entire address in a single string with the
specified line separator.
|
java.lang.String |
getInvoiceDueDate()
Returns the invoice due date.
|
java.lang.String |
getInvoiceNum()
Returns the invoice number.
|
java.lang.String |
getPONumber()
Returns the shipment PO Number.
|
java.lang.String |
getShipDate()
Returns the shipping date.
|
java.util.ArrayList<FOrderDetail> |
getShipDetails()
Returns collection of shipping details.
|
java.lang.String |
getShipmentNum()
Returns the shipment number.
|
java.lang.String |
getShipper()
Returns the shipper code.
|
java.lang.String |
getShiptoAddress1()
Returns the ship-to address line 1.
|
java.lang.String |
getShiptoAddress2()
Returns the ship-to address line 2.
|
java.lang.String |
getShiptoAddress3()
Returns the ship-to address line 3.
|
java.lang.String |
getShiptoAddress4()
Returns the ship-to address line 4.
|
java.lang.String |
getShiptoCityStZip()
Returns the ship-to city, state, zip.
|
java.lang.String |
getShiptoId()
Returns the ship-to customer id.
|
java.lang.String |
getShiptoName()
Returns the ship-to name.
|
java.util.ArrayList<java.lang.String> |
getTrackingNums()
Returns the set of shipment tracking numbers.
|
protected void |
removeUnwantedFields()
Removes unwanted fields from a JSON object or from an array of JSON objects.
|
void |
setInvoiceDueDate(java.lang.String value)
Sets the invoice due date.
|
void |
setInvoiceNum(java.lang.String value)
Sets the invoice number.
|
void |
setPONumber(java.lang.String value)
Sets the shipment PO Number.
|
void |
setShipDate(java.lang.String value)
Sets the shipping date.
|
void |
setShipmentNum(java.lang.String value)
Sets the shipment number.
|
void |
setShipper(java.lang.String value)
Sets the shipper code.
|
void |
setShiptoAddress1(java.lang.String value)
Sets the ship-to address line 1.
|
void |
setShiptoAddress2(java.lang.String value)
Sets the ship-to address line 2.
|
void |
setShiptoAddress3(java.lang.String value)
Sets the ship-to address line 3.
|
void |
setShiptoAddress4(java.lang.String value)
Sets the ship-to address line 4.
|
void |
setShiptoCityStZip(java.lang.String value)
Sets the ship-to city, state, zip.
|
void |
setShiptoId(java.lang.String value)
Sets the ship-to customer id.
|
void |
setShiptoName(java.lang.String value)
Sets the ship-to name.
|
after, before, compareTo, equals, getHashFields, getObjectFields, hashCode, removeStringWhitespace, removeUnwantedFields, setHashFields, setObjectFields, toJSONString, toStringprivate static final long serialVersionUID
protected java.util.ArrayList<FOrderDetail> ivShipDtls
public FShipSummary()
FShipSummary object with all field values set to
null.public FShipSummary(java.util.HashMap<java.lang.String,java.lang.Object> source)
FShipSummary object with field values based on the
supplied hash map.source - (HashMap) A hash map of field names and values.public FShipSummary(java.lang.String source)
FShipSummary object with field values based on the
supplied JSON text string.source - (String) A string beginning with {
(left brace) and ending with }
(right brace).protected void removeUnwantedFields()
removeUnwantedFields in class APIParam<FShipSummary>public java.lang.String getShipper()
public void setShipper(java.lang.String value)
value - (String) The shipper code.public java.lang.String getShipDate()
public void setShipDate(java.lang.String value)
value - (String) The shipping date.public void addTrackingNum(java.lang.String track)
String collection.track - (String) The tracking number.public java.util.ArrayList<java.lang.String> getTrackingNums()
public java.lang.String getShipmentNum()
public void setShipmentNum(java.lang.String value)
value - (String) The shipment number.public java.lang.String getInvoiceNum()
public void setInvoiceNum(java.lang.String value)
value - (String) The invoice number.public java.lang.String getInvoiceDueDate()
public void setInvoiceDueDate(java.lang.String value)
value - (String) The invoice due date.public java.lang.String getPONumber()
public void setPONumber(java.lang.String value)
value - (String) The PO Number.public java.lang.String getShiptoId()
public void setShiptoId(java.lang.String value)
value - (String) The ordering ship-to id.public java.lang.String getShiptoName()
public void setShiptoName(java.lang.String value)
value - (String) The ship-to name.public java.lang.String getShiptoAddress1()
public void setShiptoAddress1(java.lang.String value)
value - (String) The ship-to address line 1.public java.lang.String getShiptoAddress2()
public void setShiptoAddress2(java.lang.String value)
value - (String) The ship-to address line 2.public java.lang.String getShiptoAddress3()
public void setShiptoAddress3(java.lang.String value)
value - (String) The ship-to address line 3.public java.lang.String getShiptoAddress4()
public void setShiptoAddress4(java.lang.String value)
value - (String) The ship-to address line 4.public java.lang.String getShiptoCityStZip()
public void setShiptoCityStZip(java.lang.String value)
value - (String) The ship-to city, state, zip.public java.util.ArrayList<FOrderDetail> getShipDetails()
public java.lang.String fmtShiptoAddress()
public java.lang.String fmtShiptoAddress(java.lang.String lineSeparator)
lineSeparator - (String) The characters to use between lines.