FOrder

java.lang.Object
- com.dpslink.notification.api.param.APIParam<FOrder>
- - com.dpslink.notification.api.param.FOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FOrder>
```
public class FOrder
extends APIParam<FOrder>
```
Defines the fields and methods for a Flash order summary API parameter object.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<FOrderDetail>`	`ivOrderDtls` The order's collection of order details.
`protected java.util.ArrayList<FPaymentDetail>`	`ivPymtDtls` The order's collection of payment details.
`protected java.util.ArrayList<FShipSummary>`	`ivShipSums` The order's collection of shipment summaries.
`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
`FOrder()` Constructs a `FOrder` object with all field values set to `null`.
`FOrder(java.util.HashMap<java.lang.String,java.lang.Object> source)` Constructs a `FOrder` object with field values based on the supplied hash map.
`FOrder(java.lang.String source)` Constructs a `FOrder` object with field values based on the supplied JSON text string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`getBilltoId()` Returns the bill-to customer id.
`java.lang.String`	`getContractNumber()` Returns the contract number.
`java.lang.String`	`getCustomerId()` Returns the ordering customer id.
`java.lang.String`	`getFreight()` Returns the freight amount.
`java.lang.String`	`getOrderDate()` Returns the order date.
`java.util.ArrayList<FOrderDetail>`	`getOrderDetails()` Returns the collection of order line items.
`java.lang.String`	`getOrderNumber()` Returns the order number.
`java.lang.String`	`getPaidbyId()` Returns the paid-by customer id.
`java.util.ArrayList<FPaymentDetail>`	`getPaymentDetails()` Returns the collection of payment detail items.
`java.lang.String`	`getPONumber()` Returns the order PO Number.
`java.lang.String`	`getReqShipDate()` Returns the order's requested shipping date.
`java.lang.String`	`getShipper()` Returns the shipper code.
`java.util.ArrayList<FShipSummary>`	`getShipSummaries()` Returns the collection of shipment summary records.
`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.lang.String`	`getStatus()` Returns the order status.
`java.lang.String`	`getTax()` Returns the tax amount.
`java.lang.String`	`getType()` Returns the order type.
`java.lang.String`	`getUserDefinedField1()` Returns the order additional info.
`java.lang.String`	`getValue()` Returns the order value.
`boolean`	`isCanceled()` Answers if this order object has a canceled status.
`boolean`	`isCredit()` Answers if this order object is for an credit memo.
`boolean`	`isHeld()` Answers if this order object has a held status.
`boolean`	`isOpen()` Answers if this order object has an open status.
`boolean`	`isOrder()` Answers if this order object is for an order (not a quote, not a credit memo, etc.).
`boolean`	`isQuote()` Answers if this order object is for a quote.
`protected void`	`removeUnwantedFields()` Removes unwanted fields from a JSON object or from an array of JSON objects.
`void`	`setBilltoId(java.lang.String value)` Sets the bill-to customer id.
`void`	`setContractNumber(java.lang.String value)` Sets the contract number.
`void`	`setCustomerId(java.lang.String value)` Sets the ordering customer id.
`void`	`setFreight(java.lang.String value)` Sets the freight amount.
`void`	`setOrderDate(java.lang.String value)` Sets the order date.
`void`	`setOrderNumber(java.lang.String value)` Sets the order number.
`void`	`setPaidbyId(java.lang.String value)` Sets the paid-by customer id.
`void`	`setPONumber(java.lang.String value)` Sets the order PO Number.
`void`	`setReqShipDate(java.lang.String value)` Sets the order's requested shipping date.
`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.
`void`	`setStatus(java.lang.String value)` Sets the order status.
`void`	`setTax(java.lang.String value)` Sets the tax amount.
`void`	`setType(java.lang.String value)` Sets the order type.
`void`	`setUserDefinedField1(java.lang.String value)` Sets the order additional info.
`void`	`setValue(java.lang.String value)` Sets the order value.

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
  - ivOrderDtls
```
protected java.util.ArrayList<FOrderDetail> ivOrderDtls
```
    The order's collection of order details.
  - ivShipSums
```
protected java.util.ArrayList<FShipSummary> ivShipSums
```
    The order's collection of shipment summaries.
  - ivPymtDtls
```
protected java.util.ArrayList<FPaymentDetail> ivPymtDtls
```
    The order's collection of payment details.
- Constructor Detail
  - FOrder
```
public FOrder()
```
    Constructs a FOrder object with all field values set to null.
  - FOrder
```
public FOrder(java.util.HashMap<java.lang.String,java.lang.Object> source)
```
    Constructs a FOrder object with field values based on the supplied hash map.
    
    Parameters:
    
    source - (HashMap) A hash map of field names and values.
  - FOrder
```
public FOrder(java.lang.String source)
```
    Constructs a FOrder 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<FOrder>
  - getOrderNumber
```
public java.lang.String getOrderNumber()
```
    Returns the order number.
    
    Returns:
    
    String - The order number.
  - setOrderNumber
```
public void setOrderNumber(java.lang.String value)
```
    Sets the order number.
    
    Parameters:
    
    value - (String) The order number.
  - getStatus
```
public java.lang.String getStatus()
```
    Returns the order status.
    
    Returns:
    
    String - The order status.
  - setStatus
```
public void setStatus(java.lang.String value)
```
    Sets the order status.
    
    Parameters:
    
    value - (String) The order status.
  - getReqShipDate
```
public java.lang.String getReqShipDate()
```
    Returns the order's requested shipping date.
    
    Returns:
    
    String - The requested shipping date.
  - setReqShipDate
```
public void setReqShipDate(java.lang.String value)
```
    Sets the order's requested shipping date.
    
    Parameters:
    
    value - (String) - The requested shipping date.
  - getContractNumber
```
public java.lang.String getContractNumber()
```
    Returns the contract number.
    
    Returns:
    
    String - The contract number.
  - setContractNumber
```
public void setContractNumber(java.lang.String value)
```
    Sets the contract number.
    
    Parameters:
    
    value - (String) - The contract number.
  - getPONumber
```
public java.lang.String getPONumber()
```
    Returns the order PO Number.
    
    Returns:
    
    String - The PO Number.
  - setPONumber
```
public void setPONumber(java.lang.String value)
```
    Sets the order PO Number.
    
    Parameters:
    
    value - (String) The PO Number.
  - getUserDefinedField1
```
public java.lang.String getUserDefinedField1()
```
    Returns the order additional info.
    
    Returns:
    
    String - The additional info.
  - setUserDefinedField1
```
public void setUserDefinedField1(java.lang.String value)
```
    Sets the order additional info.
    
    Parameters:
    
    value - (String) The additional info field.
  - getOrderDate
```
public java.lang.String getOrderDate()
```
    Returns the order date.
    
    Returns:
    
    String - The order date.
  - setOrderDate
```
public void setOrderDate(java.lang.String value)
```
    Sets the order date.
    
    Parameters:
    
    value - (String) The order date.
  - getCustomerId
```
public java.lang.String getCustomerId()
```
    Returns the ordering customer id.
    
    Returns:
    
    String - The ordering customer id.
  - setCustomerId
```
public void setCustomerId(java.lang.String value)
```
    Sets the ordering customer id.
    
    Parameters:
    
    value - (String) The ordering customer id.
  - getValue
```
public java.lang.String getValue()
```
    Returns the order value.
    
    Returns:
    
    String - The order value.
  - setValue
```
public void setValue(java.lang.String value)
```
    Sets the order value.
    
    Parameters:
    
    value - (String) The order value.
  - 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.
  - getBilltoId
```
public java.lang.String getBilltoId()
```
    Returns the bill-to customer id.
    
    Returns:
    
    String - The bill-to customer id.
  - setBilltoId
```
public void setBilltoId(java.lang.String value)
```
    Sets the bill-to customer id.
    
    Parameters:
    
    value - (String) The ordering bill-to id.
  - getPaidbyId
```
public java.lang.String getPaidbyId()
```
    Returns the paid-by customer id.
    
    Returns:
    
    String - The paid-by customer id.
  - setPaidbyId
```
public void setPaidbyId(java.lang.String value)
```
    Sets the paid-by customer id.
    
    Parameters:
    
    value - (String) The ordering paid-by id.
  - getFreight
```
public java.lang.String getFreight()
```
    Returns the freight amount.
    
    Returns:
    
    String - The freight amount.
  - setFreight
```
public void setFreight(java.lang.String value)
```
    Sets the freight amount.
    
    Parameters:
    
    value - (String) The freight amount.
  - getShipper
```
public java.lang.String getShipper()
```
    Returns the shipper code.
    
    Returns:
    
    String - The shipper code.
  - setShipper
```
public void setShipper(java.lang.String value)
```
    Sets the shipper code.
    
    Parameters:
    
    value - (String) The shipper code.
  - getTax
```
public java.lang.String getTax()
```
    Returns the tax amount.
    
    Returns:
    
    String - The tax amount.
  - setTax
```
public void setTax(java.lang.String value)
```
    Sets the tax amount.
    
    Parameters:
    
    value - (String) The tax amount.
  - getType
```
public java.lang.String getType()
```
    Returns the order type.
    
    Returns:
    
    String - The order type.
  - setType
```
public void setType(java.lang.String value)
```
    Sets the order type.
    
    Parameters:
    
    value - (String) The order type.
  - getOrderDetails
```
public java.util.ArrayList<FOrderDetail> getOrderDetails()
```
    Returns the collection of order line items.
    
    Returns:
    
    ArrayList - The collection of line item details.
  - getShipSummaries
```
public java.util.ArrayList<FShipSummary> getShipSummaries()
```
    Returns the collection of shipment summary records.
    
    Returns:
    
    ArrayList - The collection of shipment summary records.
  - getPaymentDetails
```
public java.util.ArrayList<FPaymentDetail> getPaymentDetails()
```
    Returns the collection of payment detail items.
    
    Returns:
    
    ArrayList - The collection of payment detail items.
  - 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.
  - isOrder
```
public boolean isOrder()
```
    Answers if this order object is for an order (not a quote, not a credit memo, etc.).
    
    Returns:
    
    boolean - true if this is an order, otherwise false
  - isQuote
```
public boolean isQuote()
```
    Answers if this order object is for a quote.
    
    Returns:
    
    boolean - true if this is a quote, otherwise false
  - isCredit
```
public boolean isCredit()
```
    Answers if this order object is for an credit memo.
    
    Returns:
    
    boolean - true if this is a credit memo, otherwise false
  - isHeld
```
public boolean isHeld()
```
    Answers if this order object has a held status.
    
    Returns:
    
    boolean - true if the status is held, otherwise false
  - isOpen
```
public boolean isOpen()
```
    Answers if this order object has an open status.
    
    Returns:
    
    boolean - true if the status is open, otherwise false
  - isCanceled
```
public boolean isCanceled()
```
    Answers if this order object has a canceled status.
    
    Returns:
    
    boolean - true if the status is canceled, otherwise false

Class FOrder

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

ivOrderDtls

ivShipSums

ivPymtDtls

Constructor Detail

FOrder

FOrder

FOrder

Method Detail

removeUnwantedFields

getOrderNumber

setOrderNumber

getStatus

setStatus

getReqShipDate

setReqShipDate

getContractNumber

setContractNumber

getPONumber

setPONumber

getUserDefinedField1

setUserDefinedField1

getOrderDate

setOrderDate

getCustomerId

setCustomerId

getValue

setValue

getShiptoId

setShiptoId

getShiptoName

setShiptoName

getShiptoAddress1

setShiptoAddress1

getShiptoAddress2

setShiptoAddress2

getShiptoAddress3

setShiptoAddress3

getShiptoAddress4

setShiptoAddress4

getShiptoCityStZip

setShiptoCityStZip

getBilltoId

setBilltoId

getPaidbyId

setPaidbyId

getFreight

setFreight

getShipper

setShipper

getTax

setTax

getType

setType

getOrderDetails

getShipSummaries

getPaymentDetails

fmtShiptoAddress

fmtShiptoAddress

isOrder

isQuote

isCredit

isHeld

isOpen

isCanceled