com.ibm.commerce.order.beans
Class OrderDataBean

java.lang.Object
  |
  +--com.ibm.commerce.order.beansrc.OrderDataBeanBase
        |
        +--com.ibm.commerce.order.beans.OrderDataBean
All Implemented Interfaces:
DataBean, InputDataBean, OrderInputDataBean, java.io.Serializable

public class OrderDataBean
extends com.ibm.commerce.order.beansrc.OrderDataBeanBase
implements OrderInputDataBean

This data bean represents an order.

See Also:
Serialized Form

Field Summary
protected  CommandContext commandContext
          command context
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String EC_DEEP_FETCH
          deep fetch boolean
protected  boolean securityCheck
          security check
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
OrderDataBean()
          OrderDataBean constructor comment.
OrderDataBean( OrderAccessBean aabOrder)
          Constructs an OrderDataBean from an OrderAccessBean by extracting the Order EJB reference from the OrderAccessBean.
OrderDataBean( OrderAccessBean aabOrder, CommandContext aCommandContext)
          Constructs an OrderDataBean from an OrderAccessBean by extracting the Order EJB reference from the OrderAccessBean and setting the commandContext
 
Method Summary
protected  void checkOrder()
          Check if the order belongs to the user.
 boolean fulfills(java.lang.Long member, java.lang.String relationship)
          Used by access control
 java.math.BigDecimal getAdjustmentTotal(java.lang.Integer anCalculationUsageId, java.lang.Integer anDisplayLevel)
          Returns the adjustment total of this Order, with the specified CalculationUsage and display level.
  AddressDataBean getBillingAddressDataBean()
          Gets billing address
  OrderDataBean[] getChildFinalOrders()
          Returns final child order
  OrderDataBean[] getChildInitialOrders()
          Returns initial child order
  OrderDataBean[] getChildOrders(java.lang.Integer[] aDistributorStoreIds, java.lang.String aRelType)
          Returns child order for a list of distributors by and RelType
  OrderDataBean[] getChildSelectionOrders()
          Returns selection child order
  OrderDataBean[] getChildSubmissionOrders()
          Returns submission child order
  CommandContext getCommandContext()
          Gets command context
 java.math.BigDecimal getCouponAdjustmentTotal()
          Returns the adjustment total of this Order, with CalculationUsage -5 (i.e.
 java.math.BigDecimal getDiscountAdjustedProductTotal()
          Returns the discount adjusted product total of this Order.
 java.lang.String getDistributorName()
          Returns the name of the distributor that the order belongs
 java.lang.String getFormattedActualShipDate()
          Return formatted ActualShipDate
  FormattedMonetaryAmountDataBean getFormattedCouponAdjustmentTotal()
          Returns the formatted adjustment total of this Order, with CalculationUsage -5 (i.e.
  FormattedMonetaryAmountDataBean getFormattedDiscountAdjustedProductTotal()
          Returns the formatted discount adjusted product total of this Order.
 java.lang.String getFormattedEstimatedShipDate()
          Return formatted EstimatedShipDate
 java.lang.String getFormattedLastUpdateTime()
          Return formatted Order Last Update Time
 java.lang.String getFormattedOrderPlacedTime()
          Return formatted Order Placed Time
  FormattedMonetaryAmountDataBean getFormattedTotalAdjustment()
          Return the total adjustment in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTotalProductPrice()
          Return the total price in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTotalShippingCharge()
          Return the total shipping charge in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTotalShippingTax()
          Return the total shipping tax in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTotalTax()
          Return the total tax in FormattedMonetaryAmountDataBean.
  PriceDataBean getGrandTotal()
          Return the grand total price in PriceDataBean.
 int getNumberOfOrderItems()
          Return number of order items in this order.
  OrderAdjustmentDataBean[] getOrderAdjustmentDataBeans()
          Returns the OrderAdjustments of this Order.
  OrderAdjustmentDataBean[] getOrderAdjustmentDataBeans(java.lang.Integer anCalculationUsageId, java.lang.Integer anDisplayLevel)
          Returns the OrderAdjustments of this Order, with the specified CalculationUsage and display level.
  OrderFulfillmentStatusDataBean getOrderFulfillmentStatusDataBean()
          Return OrderStatusDataBean for this order
 java.lang.String getOrderId()
          Return the order id.
  OrderItemDataBean[] getOrderItemDataBeans()
          Return all OrderItemDataBeans in this order.
  OrderItemAccessBean[] getOrderItems()
          Return all OrderItemAccessBean in this order.
  OrderAdjustmentDataBean[] getOrderLevelDiscountOrderAdjustmentDataBeans()
          Returns the OrderAdjustmentDataBeans of this Order, with CalculationUsage -1 (i.e.
  OrderDataBean getParentOrder()
          Returns parent order according to the ordquotrel table
 java.lang.String getPurchaseOrderNumber()
          Return the Buyer Purchase Order Number associated with this order.
  TypedProperty getRequestProperties()
          Gets the request property set within this bean.
  OrderDataBean[] getSiblingFinalOrders()
          Returns sibling final orders
  OrderDataBean[] getSiblingInitialOrders()
          Returns sibling initial orders
  OrderDataBean[] getSiblingSelectionOrders()
          Returns sibling selection orders
  OrderDataBean[] getSiblingSubmissionOrders()
          Returns sibling submission orders
  SubOrderAccessBean[] getSubOrders()
          Return all SubOrderAccessBean in this order.
  PriceDataBean getSubTotal()
          Return the sub total.
  CategorizedMonetaryAmountsDataBean getTaxes()
          Return the tax amounts for each of the tax categories that have been computed for the order.
 java.lang.String getTotalOrderItemsPrice()
          Return the grand total price
 java.math.BigDecimal getTotalProductPriceBySumUp()
          Return the total price in FormattedMonetaryAmountDataBean.
 boolean isAllItemsAvailable()
          Returns true if all orderItems have AvailableQuantity that is >0, or else returns false.
 boolean isAllItemsBackOrdered()
          Returns true if all orderItems are backordered, or else returns false.
 boolean isAtLeastOneAvailabilityUnknown()
          Returns true if one of the orderItems has a null AvailableQuantity, or else returns false if all orderItems have AvailableQuantity.
 boolean isDeepFetch()
          Is deep fetched used
 boolean isEmpty()
          Does this order have any order items
 boolean isMixed()
          Checks to see if some items are available and some are back ordered.
 boolean isShipped()
          Returns true if all OrderItems have been manifested.
 void populate()
          Populate databean
 void setCommandContext( CommandContext context)
          setCommandContext method comment.
 void setDeepFetch(boolean abDeepFetch)
          To use deep fetch or not
 void setOrderId(java.lang.String anOrderId)
          Sets an order id.
 void setOrderItems( OrderItemAccessBean[] items)
          Sets an array of order item access beans (optional).
 void setOrderItems( OrderItemDataBean[] adbOrderItems)
          Sets order items
 void setRequestProperties( TypedProperty aRequestProperties)
          Sets the request properties within this bean.
 void setSecurityCheck(boolean check)
          Turn security check on or off.
 void setSubOrders( SubOrderAccessBean[] abs)
          Sets an array of sub order access beans (optional).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values

commandContext

protected CommandContext commandContext
command context

securityCheck

protected boolean securityCheck
security check

EC_DEEP_FETCH

public static final java.lang.String EC_DEEP_FETCH
deep fetch boolean
See Also:
Constant Field Values
Constructor Detail

OrderDataBean

public OrderDataBean()
OrderDataBean constructor comment.

OrderDataBean

public OrderDataBean(OrderAccessBean aabOrder,
CommandContext aCommandContext)
              throws java.lang.Exception
Constructs an OrderDataBean from an OrderAccessBean by extracting the Order EJB reference from the OrderAccessBean and setting the commandContext
Parameters:
aabOrder - OrderAccessBean
aCommandContext - Command Context
Throws:
java.lang.Exception

OrderDataBean

public OrderDataBean(OrderAccessBean aabOrder)
              throws java.lang.Exception
Constructs an OrderDataBean from an OrderAccessBean by extracting the Order EJB reference from the OrderAccessBean. Note: Consider using OrderDataBean(OrderAccessBean aabOrder,CommandContext aCommandContext) if commandContext is available.
Parameters:
aabOrder - OrderAccessBean
Throws:
java.lang.Exception
Method Detail

checkOrder

protected void checkOrder()
                   throws java.lang.Exception
Check if the order belongs to the user.
Throws:
java.lang.Exception

getCommandContext

public CommandContext getCommandContext()
Gets command context
Returns:
CommandContext

getFormattedTotalAdjustment

public FormattedMonetaryAmountDataBean getFormattedTotalAdjustment()
                                                            throws javax.ejb.CreateException,
                                                                   javax.ejb.FinderException,
                                                                   java.rmi.RemoteException,
                                                                   javax.naming.NamingException,
ECSystemException
Return the total adjustment in FormattedMonetaryAmountDataBean.
Returns:
FormattedMonetaryAmountDataBean
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

getFormattedTotalProductPrice

public FormattedMonetaryAmountDataBean getFormattedTotalProductPrice()
                                                              throws javax.ejb.CreateException,
                                                                     javax.ejb.FinderException,
                                                                     java.rmi.RemoteException,
                                                                     javax.naming.NamingException,
ECSystemException
Return the total price in FormattedMonetaryAmountDataBean.
Returns:
FormattedMonetaryAmountDataBean
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

getFormattedTotalShippingCharge

public FormattedMonetaryAmountDataBean getFormattedTotalShippingCharge()
                                                                throws javax.ejb.CreateException,
                                                                       javax.ejb.FinderException,
                                                                       java.rmi.RemoteException,
                                                                       javax.naming.NamingException,
ECSystemException
Return the total shipping charge in FormattedMonetaryAmountDataBean.
Returns:
FormattedMonetaryAmountDataBean
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

getFormattedTotalShippingTax

public FormattedMonetaryAmountDataBean getFormattedTotalShippingTax()
                                                             throws javax.ejb.CreateException,
                                                                    javax.ejb.FinderException,
                                                                    java.rmi.RemoteException,
                                                                    javax.naming.NamingException,
ECSystemException
Return the total shipping tax in FormattedMonetaryAmountDataBean.
Returns:
FormattedMonetaryAmountDataBean
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

getFormattedTotalTax

public FormattedMonetaryAmountDataBean getFormattedTotalTax()
                                                     throws javax.ejb.CreateException,
                                                            javax.ejb.FinderException,
                                                            java.rmi.RemoteException,
                                                            javax.naming.NamingException,
ECSystemException
Return the total tax in FormattedMonetaryAmountDataBean.
Returns:
FormattedMonetaryAmountDataBean
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

getFormattedEstimatedShipDate

public java.lang.String getFormattedEstimatedShipDate()
Return formatted EstimatedShipDate
Returns:
String

getFormattedActualShipDate

public java.lang.String getFormattedActualShipDate()
Return formatted ActualShipDate
Returns:
String

getFormattedOrderPlacedTime

public java.lang.String getFormattedOrderPlacedTime()
Return formatted Order Placed Time
Returns:
String

getFormattedLastUpdateTime

public java.lang.String getFormattedLastUpdateTime()
Return formatted Order Last Update Time
Returns:
String

getGrandTotal

public PriceDataBean getGrandTotal()
Return the grand total price in PriceDataBean.
Returns:
String

getTotalOrderItemsPrice

public java.lang.String getTotalOrderItemsPrice()
Return the grand total price
Returns:
String

getOrderId

public java.lang.String getOrderId()
Return the order id.
Returns:
String

isEmpty

public boolean isEmpty()
Does this order have any order items
Returns:
boolean

getBillingAddressDataBean

public AddressDataBean getBillingAddressDataBean()
Gets billing address
Returns:
AddressDataBean

getOrderItemDataBeans

public OrderItemDataBean[] getOrderItemDataBeans()
Return all OrderItemDataBeans in this order.
Returns:
OrderItemDataBean array

getNumberOfOrderItems

public int getNumberOfOrderItems()
Return number of order items in this order.
Returns:
int

getOrderItems

public OrderItemAccessBean[] getOrderItems()
Return all OrderItemAccessBean in this order.
Returns:
OrderItemAccessBean

getPurchaseOrderNumber

public java.lang.String getPurchaseOrderNumber()
Return the Buyer Purchase Order Number associated with this order.
Returns:
String

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request property set within this bean.
Specified by:
getRequestProperties in interface InputDataBean
Returns:
com.ibm.commerce.datatype.TypedProperty

getSubOrders

public SubOrderAccessBean[] getSubOrders()
Return all SubOrderAccessBean in this order.
Returns:
SubOrderAccessBean array

getSubTotal

public PriceDataBean getSubTotal()
Return the sub total.
Returns:
PriceDataBean

getTaxes

public CategorizedMonetaryAmountsDataBean getTaxes()
                                            throws javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   java.rmi.RemoteException,
                                                   javax.naming.NamingException,
ECSystemException
Return the tax amounts for each of the tax categories that have been computed for the order.
Returns:
the CategorizedMonetaryAmountsDataBean containing the taxing monetary amounts, names and descriptions etc.
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

getTotalProductPriceBySumUp

public java.math.BigDecimal getTotalProductPriceBySumUp()
                                                 throws javax.ejb.CreateException,
                                                        javax.ejb.FinderException,
                                                        java.rmi.RemoteException,
                                                        javax.naming.NamingException,
ECSystemException
Return the total price in FormattedMonetaryAmountDataBean.
Returns:
BigDecimal
Throws:
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException

isDeepFetch

public boolean isDeepFetch()
Is deep fetched used
Returns:
boolean

populate

public void populate()
              throws java.lang.Exception
Populate databean
Throws:
java.lang.Exception

setCommandContext

public void setCommandContext(CommandContext context)
setCommandContext method comment.
Parameters:
context - CommandContext

setDeepFetch

public void setDeepFetch(boolean abDeepFetch)
To use deep fetch or not
Parameters:
abDeepFetch - boolean

setOrderId

public void setOrderId(java.lang.String anOrderId)
Sets an order id.
Specified by:
setOrderId in interface OrderInputDataBean
Parameters:
anOrderId - order id

setOrderItems

public void setOrderItems(OrderItemDataBean[] adbOrderItems)
Sets order items
Parameters:
adbOrderItems - OrderItemDataBean array

setOrderItems

public void setOrderItems(OrderItemAccessBean[] items)
Sets an array of order item access beans (optional).
Specified by:
setOrderItems in interface OrderInputDataBean
Parameters:
items - OrderItemAccessBean array

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws javax.ejb.CreateException,
                                 java.rmi.RemoteException,
                                 javax.naming.NamingException,
                                 javax.ejb.FinderException
Sets the request properties within this bean.
Specified by:
setRequestProperties in interface InputDataBean
Parameters:
aRequestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
javax.ejb.CreateException
java.rmi.RemoteException
javax.naming.NamingException
javax.ejb.FinderException

setSecurityCheck

public void setSecurityCheck(boolean check)
Turn security check on or off.
Specified by:
setSecurityCheck in interface OrderInputDataBean
Parameters:
check - boolean

setSubOrders

public void setSubOrders(SubOrderAccessBean[] abs)
Sets an array of sub order access beans (optional).
Specified by:
setSubOrders in interface OrderInputDataBean
Parameters:
abs - SubOrderAccessBean array

fulfills

public boolean fulfills(java.lang.Long member,
                        java.lang.String relationship)
                 throws java.rmi.RemoteException,
                        java.lang.Exception
Used by access control
Parameters:
member - Long
relationship - String
Returns:
boolean
Throws:
java.rmi.RemoteException
java.lang.Exception

getChildOrders

public OrderDataBean[] getChildOrders(java.lang.Integer[] aDistributorStoreIds,
                                      java.lang.String aRelType)
Returns child order for a list of distributors by and RelType
Parameters:
aDistributorStoreIds - Integer array
aRelType - String order quotation relation type
Returns:
OrderDataBean array

getParentOrder

public OrderDataBean getParentOrder()
Returns parent order according to the ordquotrel table
Returns:
OrderDataBean

isAtLeastOneAvailabilityUnknown

public boolean isAtLeastOneAvailabilityUnknown()
Returns true if one of the orderItems has a null AvailableQuantity, or else returns false if all orderItems have AvailableQuantity.
Returns:
boolean

isAllItemsAvailable

public boolean isAllItemsAvailable()
Returns true if all orderItems have AvailableQuantity that is >0, or else returns false.
Returns:
boolean

isAllItemsBackOrdered

public boolean isAllItemsBackOrdered()
Returns true if all orderItems are backordered, or else returns false.
Returns:
boolean

isShipped

public boolean isShipped()
Returns true if all OrderItems have been manifested.
Returns:
boolean

isMixed

public boolean isMixed()
Checks to see if some items are available and some are back ordered.
Returns:
boolean

getOrderFulfillmentStatusDataBean

public OrderFulfillmentStatusDataBean getOrderFulfillmentStatusDataBean()
Return OrderStatusDataBean for this order
Returns:
OrderFulfillmentStatusDataBean

getChildSelectionOrders

public OrderDataBean[] getChildSelectionOrders()
Returns selection child order
Returns:
OrderDataBean array

getChildInitialOrders

public OrderDataBean[] getChildInitialOrders()
Returns initial child order
Returns:
OrderDataBean array

getChildFinalOrders

public OrderDataBean[] getChildFinalOrders()
Returns final child order
Returns:
OrderDataBean array

getChildSubmissionOrders

public OrderDataBean[] getChildSubmissionOrders()
Returns submission child order
Returns:
OrderDataBean array

getSiblingSelectionOrders

public OrderDataBean[] getSiblingSelectionOrders()
Returns sibling selection orders
Returns:
OrderDataBean array

getSiblingInitialOrders

public OrderDataBean[] getSiblingInitialOrders()
Returns sibling initial orders
Returns:
OrderDataBean array

getSiblingSubmissionOrders

public OrderDataBean[] getSiblingSubmissionOrders()
Returns sibling submission orders
Returns:
OrderDataBean array

getSiblingFinalOrders

public OrderDataBean[] getSiblingFinalOrders()
Returns sibling final orders
Returns:
OrderDataBean array

getDistributorName

public java.lang.String getDistributorName()
Returns the name of the distributor that the order belongs
Returns:
String

getOrderAdjustmentDataBeans

public OrderAdjustmentDataBean[] getOrderAdjustmentDataBeans()
Returns the OrderAdjustments of this Order.
Returns:
the OrderAdjustmentDataBeans, or null if none is found or an error has occurred during its retrieval.

getOrderAdjustmentDataBeans

public OrderAdjustmentDataBean[] getOrderAdjustmentDataBeans(java.lang.Integer anCalculationUsageId,
                                                             java.lang.Integer anDisplayLevel)
Returns the OrderAdjustments of this Order, with the specified CalculationUsage and display level.
Parameters:
anCalculationUsageId - the CalculationUsage ID. Null means any CalculationUsage.
anDisplayLevel - the display level. Null means any display level.
Returns:
the OrderAdjustmentDataBeans, or null if none is found or an error has occurred during its retrieval.

getOrderLevelDiscountOrderAdjustmentDataBeans

public OrderAdjustmentDataBean[] getOrderLevelDiscountOrderAdjustmentDataBeans()
Returns the OrderAdjustmentDataBeans of this Order, with CalculationUsage -1 (i.e. discount) and display level 1 (i.e. Order). Equivalent to getOrderAdjustmentDataBeans(new Integer(-1), new Integer(1)).
Returns:
the OrderAdjustmentDataBeans, or null if none is found or an error has occurred during its retrieval.

getAdjustmentTotal

public java.math.BigDecimal getAdjustmentTotal(java.lang.Integer anCalculationUsageId,
                                               java.lang.Integer anDisplayLevel)
Returns the adjustment total of this Order, with the specified CalculationUsage and display level.
Parameters:
anCalculationUsageId - the CalculationUsage ID. Null means any CalculationUsage.
anDisplayLevel - the display level. Null means any display level.
Returns:
the adjustment total, or null if an error has occurred.

getDiscountAdjustedProductTotal

public java.math.BigDecimal getDiscountAdjustedProductTotal()
Returns the discount adjusted product total of this Order. Equivalent to getTotalProductPriceInEJBType().add( getAdjustmentTotal(new Integer(-1), null)).
Returns:
the discount adjusted product total, or null if an error has occurred.

getFormattedDiscountAdjustedProductTotal

public FormattedMonetaryAmountDataBean getFormattedDiscountAdjustedProductTotal()
Returns the formatted discount adjusted product total of this Order.
Returns:
the discount adjusted product total, or null if an error has occurred.
See Also:
getDiscountAdjustedProductTotal()

getCouponAdjustmentTotal

public java.math.BigDecimal getCouponAdjustmentTotal()
Returns the adjustment total of this Order, with CalculationUsage -5 (i.e. coupon). Equivalent to getAdjustmentTotal(new Integer(-5), null).
Returns:
the adjustment total, or null if an error has occurred.

getFormattedCouponAdjustmentTotal

public FormattedMonetaryAmountDataBean getFormattedCouponAdjustmentTotal()
Returns the formatted adjustment total of this Order, with CalculationUsage -5 (i.e. coupon).
Returns:
the adjustment total, or null if an error has occurred.
See Also:
getCouponAdjustmentTotal()