com.elasticpath.domain.order
Interface OrderShipment

All Superinterfaces:
EpDomain, Persistence, java.io.Serializable, ValueObject
All Known Implementing Classes:
OrderShipmentImpl

public interface OrderShipment
extends ValueObject

OrderShipment represents a customer's order shipment.


Method Summary
 void addOrderSku(OrderSku orderSku)
          Add an order SKU.
 java.math.BigDecimal getBeforeTaxShippingCost()
          Get the before-tax shipping cost in BigDecimal.
 java.lang.String getCarrier()
           
 java.util.Date getCreatedDate()
          Get the date that this order was created on.
 java.util.Date getLastModifiedDate()
          Get the date that the order was last modified on.
 java.util.Set getOrderSkus()
          Get the SKUs in this shipment.
 java.lang.String getServiceLevel()
           
 OrderAddress getShipmentAddress()
          Get the shipment address corresponding to this shipment.
 java.util.Date getShipmentDate()
          Get the date that the order was shipped on.
 java.math.BigDecimal getShippingCost()
          Get the shipping cost in BigDecimal.
 OrderShipmentStatus getStatus()
          Get the status of the shipment.
 java.lang.String getTrackingCode()
           
 void setBeforeTaxShippingCost(java.math.BigDecimal beforeTaxShippingCost)
          Set the before-tax shipping cost in BigDecimal.
 void setCarrier(java.lang.String carrier)
           
 void setCreatedDate(java.util.Date createdDate)
          Set the date that the order is created.
 void setLastModifiedDate(java.util.Date lastModifiedDate)
          Set the date that the order was last modified on.
 void setOrderSkus(java.util.Set orderSkus)
          Set the SKUs in this shipment.
 void setServiceLevel(java.lang.String serviceLevel)
           
 void setShipmentAddress(OrderAddress shipmentAddress)
          Set the shipping address corresponding to this shipment.
 void setShipmentDate(java.util.Date shipmentDate)
          Set the date that the order was shipped on.
 void setShippingCost(java.math.BigDecimal shippingCost)
          Set the shipping cost in BigDecimal.
 void setStatus(OrderShipmentStatus status)
          Set the status of the shipment.
 void setTrackingCode(java.lang.String trackingCode)
           
 
Methods inherited from interface com.elasticpath.domain.Persistence
executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

addOrderSku

void addOrderSku(OrderSku orderSku)
Add an order SKU.

Parameters:
orderSku - the order SKU to add

getBeforeTaxShippingCost

java.math.BigDecimal getBeforeTaxShippingCost()
Get the before-tax shipping cost in BigDecimal.

Returns:
the before-tax shipping cost in BigDecimal.

getCarrier

java.lang.String getCarrier()
Returns:
Returns the carrier.

getCreatedDate

java.util.Date getCreatedDate()
Get the date that this order was created on.

Returns:
the created date

getLastModifiedDate

java.util.Date getLastModifiedDate()
Get the date that the order was last modified on.

Returns:
the last modified date

getOrderSkus

java.util.Set getOrderSkus()
Get the SKUs in this shipment.

Returns:
the shipment's OrderSkuss

getServiceLevel

java.lang.String getServiceLevel()
Returns:
Returns the serviceLevel.

getShipmentAddress

OrderAddress getShipmentAddress()
Get the shipment address corresponding to this shipment.

Returns:
the shipment address Uid

getShipmentDate

java.util.Date getShipmentDate()
Get the date that the order was shipped on.

Returns:
the shipped date

getShippingCost

java.math.BigDecimal getShippingCost()
Get the shipping cost in BigDecimal.

Returns:
the shipping cost in BigDecimal.

getStatus

OrderShipmentStatus getStatus()
Get the status of the shipment.

Returns:
the shipment status

getTrackingCode

java.lang.String getTrackingCode()
Returns:
Returns the trackingCode.

setBeforeTaxShippingCost

void setBeforeTaxShippingCost(java.math.BigDecimal beforeTaxShippingCost)
Set the before-tax shipping cost in BigDecimal.

Parameters:
beforeTaxShippingCost - the before-tax shipping cost

setCarrier

void setCarrier(java.lang.String carrier)
Parameters:
carrier - The carrier to set.

setCreatedDate

void setCreatedDate(java.util.Date createdDate)
Set the date that the order is created.

Parameters:
createdDate - the start date

setLastModifiedDate

void setLastModifiedDate(java.util.Date lastModifiedDate)
Set the date that the order was last modified on.

Parameters:
lastModifiedDate - the date that the order was last modified

setOrderSkus

void setOrderSkus(java.util.Set orderSkus)
Set the SKUs in this shipment.

Parameters:
orderSkus - the set of OrderSkus

setServiceLevel

void setServiceLevel(java.lang.String serviceLevel)
Parameters:
serviceLevel - The serviceLevel to set.

setShipmentAddress

void setShipmentAddress(OrderAddress shipmentAddress)
Set the shipping address corresponding to this shipment.

Parameters:
shipmentAddress - the Uid of the corresponding shipment address.

setShipmentDate

void setShipmentDate(java.util.Date shipmentDate)
Set the date that the order was shipped on.

Parameters:
shipmentDate - the date that the order was shipped on

setShippingCost

void setShippingCost(java.math.BigDecimal shippingCost)
Set the shipping cost in BigDecimal.

Parameters:
shippingCost - the shipping cost

setStatus

void setStatus(OrderShipmentStatus status)
Set the status of the shipment.

Parameters:
status - the status of the shipment

setTrackingCode

void setTrackingCode(java.lang.String trackingCode)
Parameters:
trackingCode - The trackingCode to set.