java.lang.Object | +--com.ibm.commerce.order.beansrc.OrderDataBeanBase | +--com.ibm.commerce.order.beans.OrderDataBean
This data bean represents an order.
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
protected CommandContext commandContext
protected boolean securityCheck
public static final java.lang.String EC_DEEP_FETCH
Constructor Detail |
---|
public OrderDataBean()
public OrderDataBean(OrderAccessBean aabOrder, CommandContext aCommandContext) throws java.lang.Exception
aabOrder
- OrderAccessBeanaCommandContext
- Command Contextjava.lang.Exception
public OrderDataBean(OrderAccessBean aabOrder) throws java.lang.Exception
aabOrder
- OrderAccessBeanjava.lang.Exception
Method Detail |
---|
protected void checkOrder() throws java.lang.Exception
java.lang.Exception
public CommandContext getCommandContext()
public FormattedMonetaryAmountDataBean getFormattedTotalAdjustment() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public FormattedMonetaryAmountDataBean getFormattedTotalProductPrice() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public FormattedMonetaryAmountDataBean getFormattedTotalShippingCharge() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public FormattedMonetaryAmountDataBean getFormattedTotalShippingTax() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public FormattedMonetaryAmountDataBean getFormattedTotalTax() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public java.lang.String getFormattedEstimatedShipDate()
public java.lang.String getFormattedActualShipDate()
public java.lang.String getFormattedOrderPlacedTime()
public java.lang.String getFormattedLastUpdateTime()
public PriceDataBean getGrandTotal()
public java.lang.String getTotalOrderItemsPrice()
public java.lang.String getOrderId()
public boolean isEmpty()
public AddressDataBean getBillingAddressDataBean()
public OrderItemDataBean[] getOrderItemDataBeans()
public int getNumberOfOrderItems()
public OrderItemAccessBean[] getOrderItems()
public java.lang.String getPurchaseOrderNumber()
public TypedProperty getRequestProperties()
getRequestProperties
in interface
InputDataBean
public SubOrderAccessBean[] getSubOrders()
public PriceDataBean getSubTotal()
public CategorizedMonetaryAmountsDataBean getTaxes() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CategorizedMonetaryAmountsDataBean
containing the taxing
monetary amounts, names and descriptions etc.CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public java.math.BigDecimal getTotalProductPriceBySumUp() throws javax.ejb.CreateException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, ECSystemException
CreateException
FinderException
java.rmi.RemoteException
javax.naming.NamingException
ECSystemException
public boolean isDeepFetch()
public void populate() throws java.lang.Exception
java.lang.Exception
public void setCommandContext(CommandContext context)
context
- CommandContextpublic void setDeepFetch(boolean abDeepFetch)
abDeepFetch
- booleanpublic void setOrderId(java.lang.String anOrderId)
setOrderId
in interface
OrderInputDataBean
anOrderId
- order idpublic void setOrderItems(OrderItemDataBean[] adbOrderItems)
adbOrderItems
- OrderItemDataBean arraypublic void setOrderItems(OrderItemAccessBean[] items)
setOrderItems
in interface
OrderInputDataBean
items
- OrderItemAccessBean arraypublic void setRequestProperties(TypedProperty aRequestProperties) throws javax.ejb.CreateException, java.rmi.RemoteException, javax.naming.NamingException, javax.ejb.FinderException
setRequestProperties
in interface
InputDataBean
aRequestProperties
-
com.ibm.commerce.datatype.TypedPropertyjavax.ejb.CreateException
java.rmi.RemoteException
javax.naming.NamingException
javax.ejb.FinderException
public void setSecurityCheck(boolean check)
setSecurityCheck
in interface
OrderInputDataBean
check
- booleanpublic void setSubOrders(SubOrderAccessBean[] abs)
setSubOrders
in interface
OrderInputDataBean
abs
- SubOrderAccessBean arraypublic boolean fulfills(java.lang.Long member, java.lang.String relationship) throws java.rmi.RemoteException, java.lang.Exception
member
- Longrelationship
- Stringjava.rmi.RemoteException
java.lang.Exception
public OrderDataBean[] getChildOrders(java.lang.Integer[] aDistributorStoreIds, java.lang.String aRelType)
aDistributorStoreIds
- Integer arrayaRelType
- String order quotation relation typepublic OrderDataBean getParentOrder()
public boolean isAtLeastOneAvailabilityUnknown()
public boolean isAllItemsAvailable()
public boolean isAllItemsBackOrdered()
public boolean isShipped()
public boolean isMixed()
public OrderFulfillmentStatusDataBean getOrderFulfillmentStatusDataBean()
public OrderDataBean[] getChildSelectionOrders()
public OrderDataBean[] getChildInitialOrders()
public OrderDataBean[] getChildFinalOrders()
public OrderDataBean[] getChildSubmissionOrders()
public OrderDataBean[] getSiblingSelectionOrders()
public OrderDataBean[] getSiblingInitialOrders()
public OrderDataBean[] getSiblingSubmissionOrders()
public OrderDataBean[] getSiblingFinalOrders()
public java.lang.String getDistributorName()
public OrderAdjustmentDataBean[] getOrderAdjustmentDataBeans()
OrderAdjustments
of this Order.
public OrderAdjustmentDataBean[] getOrderAdjustmentDataBeans(java.lang.Integer anCalculationUsageId, java.lang.Integer anDisplayLevel)
OrderAdjustments
of this Order, with the specified
CalculationUsage and display level.
anCalculationUsageId
- the CalculationUsage ID. Null means any
CalculationUsage.anDisplayLevel
- the display level. Null means any display
level.public OrderAdjustmentDataBean[] getOrderLevelDiscountOrderAdjustmentDataBeans()
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))
.
public java.math.BigDecimal getAdjustmentTotal(java.lang.Integer anCalculationUsageId, java.lang.Integer anDisplayLevel)
anCalculationUsageId
- the CalculationUsage ID. Null means any
CalculationUsage.anDisplayLevel
- the display level. Null means any display
level.public java.math.BigDecimal getDiscountAdjustedProductTotal()
getTotalProductPriceInEJBType()
.add(
getAdjustmentTotal(new Integer(-1), null)
).
public FormattedMonetaryAmountDataBean getFormattedDiscountAdjustedProductTotal()
getDiscountAdjustedProductTotal()
public java.math.BigDecimal getCouponAdjustmentTotal()
getAdjustmentTotal(new Integer(-5), null)
.
public FormattedMonetaryAmountDataBean getFormattedCouponAdjustmentTotal()
getCouponAdjustmentTotal()