com.dpslink.notification.api.param

Class FShipSummary

java.lang.Object

com.dpslink.notification.api.param.APIParam<FShipSummary>

com.dpslink.notification.api.param.FShipSummary

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FShipSummary>

public class FShipSummary
extends APIParam<FShipSummary>

Defines the fields and methods for a Flash shipment summary API parameter object.

See Also:

Serialized Form

Field Summary

Fields

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.

Fields inherited from class com.dpslink.notification.api.param.APIParam

ivHashCode, ivHashFlds, ivObjFlds

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class com.dpslink.notification.api.param.APIParam

after, before, compareTo, equals, getHashFields, getObjectFields, hashCode, removeStringWhitespace, removeUnwantedFields, setHashFields, setObjectFields, toJSONString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivShipDtls

protected java.util.ArrayList<FOrderDetail> ivShipDtls

The shipment's collection of shipment details.

Constructor Detail

FShipSummary

public FShipSummary()

Constructs a FShipSummary object with all field values set to null.

FShipSummary

public FShipSummary(java.util.HashMap<java.lang.String,java.lang.Object> source)

Constructs a FShipSummary object with field values based on the supplied hash map.

Parameters:

source - (HashMap) A hash map of field names and values.

FShipSummary

public FShipSummary(java.lang.String source)

Constructs a FShipSummary object with field values based on the supplied JSON text string.

Parameters:

source - (String) A string beginning with { (left brace) and ending with } (right brace).

Method Detail

removeUnwantedFields

protected void removeUnwantedFields()

Removes unwanted fields from a JSON object or from an array of JSON objects. Automatically invoked by the constructors.

Specified by:

removeUnwantedFields in class APIParam<FShipSummary>

getShipper

public java.lang.String getShipper()

Returns the shipper code.

Returns:

String - The shipper name.

setShipper

public void setShipper(java.lang.String value)

Sets the shipper code.

Parameters:

value - (String) The shipper code.

getShipDate

public java.lang.String getShipDate()

Returns the shipping date.

Returns:

String - The shipping date.

setShipDate

public void setShipDate(java.lang.String value)

Sets the shipping date.

Parameters:

value - (String) The shipping date.

addTrackingNum

public void addTrackingNum(java.lang.String track)

Adds a shipment tracking number to the String collection.

Parameters:

track - (String) The tracking number.

getTrackingNums

public java.util.ArrayList<java.lang.String> getTrackingNums()

Returns the set of shipment tracking numbers.

Returns:

ArrayList - The set of shipment tracking numbers.

getShipmentNum

public java.lang.String getShipmentNum()

Returns the shipment number.

Returns:

String - The shipment number.

setShipmentNum

public void setShipmentNum(java.lang.String value)

Sets the shipment number.

Parameters:

value - (String) The shipment number.

getInvoiceNum

public java.lang.String getInvoiceNum()

Returns the invoice number.

Returns:

String - The invoice number.

setInvoiceNum

public void setInvoiceNum(java.lang.String value)

Sets the invoice number.

Parameters:

value - (String) The invoice number.

getInvoiceDueDate

public java.lang.String getInvoiceDueDate()

Returns the invoice due date.

Returns:

String - The invoice due date.

setInvoiceDueDate

public void setInvoiceDueDate(java.lang.String value)

Sets the invoice due date.

Parameters:

value - (String) The invoice due date.

getPONumber

public java.lang.String getPONumber()

Returns the shipment PO Number.

Returns:

String - The PO Number.

setPONumber

public void setPONumber(java.lang.String value)

Sets the shipment PO Number.

Parameters:

value - (String) The PO Number.

getShiptoId

public java.lang.String getShiptoId()

Returns the ship-to customer id.

Returns:

String - The ship-to customer id.

setShiptoId

public void setShiptoId(java.lang.String value)

Sets the ship-to customer id.

Parameters:

value - (String) The ordering ship-to id.

getShiptoName

public java.lang.String getShiptoName()

Returns the ship-to name.

Returns:

String - The ship-to name.

setShiptoName

public void setShiptoName(java.lang.String value)

Sets the ship-to name.

Parameters:

value - (String) The ship-to name.

getShiptoAddress1

public java.lang.String getShiptoAddress1()

Returns the ship-to address line 1.

Returns:

String - The ship-to address line 1.

setShiptoAddress1

public void setShiptoAddress1(java.lang.String value)

Sets the ship-to address line 1.

Parameters:

value - (String) The ship-to address line 1.

getShiptoAddress2

public java.lang.String getShiptoAddress2()

Returns the ship-to address line 2.

Returns:

String - The ship-to address line 2.

setShiptoAddress2

public void setShiptoAddress2(java.lang.String value)

Sets the ship-to address line 2.

Parameters:

value - (String) The ship-to address line 2.

getShiptoAddress3

public java.lang.String getShiptoAddress3()

Returns the ship-to address line 3.

Returns:

String - The ship-to address line 3.

setShiptoAddress3

public void setShiptoAddress3(java.lang.String value)

Sets the ship-to address line 3.

Parameters:

value - (String) The ship-to address line 3.

getShiptoAddress4

public java.lang.String getShiptoAddress4()

Returns the ship-to address line 4.

Returns:

String - The ship-to address line 4.

setShiptoAddress4

public void setShiptoAddress4(java.lang.String value)

Sets the ship-to address line 4.

Parameters:

value - (String) The ship-to address line 4.

getShiptoCityStZip

public java.lang.String getShiptoCityStZip()

Returns the ship-to city, state, zip.

Returns:

String - The ship-to city, state, zip.

setShiptoCityStZip

public void setShiptoCityStZip(java.lang.String value)

Sets the ship-to city, state, zip.

Parameters:

value - (String) The ship-to city, state, zip.

getShipDetails

public java.util.ArrayList<FOrderDetail> getShipDetails()

Returns collection of shipping details.

Returns:

ArrayList - The collection of shipping details.

fmtShiptoAddress

public java.lang.String fmtShiptoAddress()

Returns the ship-to customer's entire address in a format suitable for display on a web page.

Returns:

String - The ship-to customer's formatted address. All address lines containing values are returned with each line (except the last) ending with an html line break (
).

fmtShiptoAddress

public 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.

Parameters:

lineSeparator - (String) The characters to use between lines.

Returns:

String - The ship-to customer's formatted address. All address lines containing values are returned with each line (except the last) ending with the specified line separator.