com.ibm.commerce.order.beans
Class OrderItemDataBean

java.lang.Object
  |
  +--com.ibm.commerce.order.beansrc.OrderItemDataBeanBase
        |
        +--com.ibm.commerce.order.beans.OrderItemDataBean

public class OrderItemDataBean
extends com.ibm.commerce.order.beansrc.OrderItemDataBeanBase

This data bean represents an order item.

See Also:
Serialized Form

Field Summary
protected  CommandContext commandContext
          command context
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
OrderItemDataBean()
          OrderItemDataBean constructor comment.
OrderItemDataBean( OrderItemAccessBean aabOrderItem)
          Constructs an OrderItemDataBean from an OrderItemAccessBean by extracting the OrderItem EJB reference from the OrderItemAccessBean.
OrderItemDataBean( OrderItemAccessBean aabOrderItem, CommandContext aCommandContext)
          Constructs an OrderItemDataBean from an OrderItemAccessBean by extracting the OrderItem EJB reference from the OrderItemAccessBean and setting the command context
 
Method Summary
 java.lang.Long getApplicableContractId()
          Return the contract price in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getApplicableContractPrice()
          Return the contract price in FormattedMonetaryAmountDataBean.
  CatalogEntryAccessBean getCatalogEntry()
          Returns CatalogEntryAccessBean
  CatalogEntryDataBean getCatalogEntryDataBean()
          Returns CatalogEntryDataBean
  OrderItemDataBean[] getChildAlternateFinalItems()
          Returns alternate final child order items
  OrderItemDataBean[] getChildAlternateFinalItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns alternate final child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildAlternateInitialItems()
          Returns alternate initial child order items
  OrderItemDataBean[] getChildAlternateInitialItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns alternate initial child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildAlternateSelectionItems()
          Returns alternate selection child order items
  OrderItemDataBean[] getChildAlternateSelectionItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns alternate selection child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildAlternateSubmissionItems()
          Returns alternate submission child order items
  OrderItemDataBean[] getChildAlternateSubmissionItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns alternate submission child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildItems(java.lang.Integer[] aDistributorStoreIds, java.lang.String aLineItemType, java.lang.String aRelType)
          Returns child order items for a list of distributors by LineItemType, and RelType LineItemType can be 'ALT','PRIM', or 'BOTH'
  OrderItemDataBean[] getChildPrimaryFinalItems()
          Returns primary final child order items
  OrderItemDataBean[] getChildPrimaryFinalItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns primary final child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildPrimaryInitialItems()
          Returns primary initial child order items
  OrderItemDataBean[] getChildPrimaryInitialItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns primary initial child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildPrimarySelectionItems()
          Returns primary selection child order items
  OrderItemDataBean[] getChildPrimarySelectionItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns primary selection child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  OrderItemDataBean[] getChildPrimarySubmissionItems()
          Returns primary submission child order items
  OrderItemDataBean[] getChildPrimarySubmissionItems(java.lang.Integer aStoreId, java.lang.Long[] aContractIdList)
          Returns primary submission child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
  CommandContext getCommandContext()
          Returns CommandContext
 java.lang.String getFormattedQuantity()
          Returns the requested quantity formatted as a string with decimal separator only shown if there is a fractional portion.
  FormattedMonetaryAmountDataBean getFormattedShippingCharge()
          Return the shipping charge in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedShippingTaxAmount()
          Return the shipping tax in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTaxAmount()
          Return the tax in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTotalAdjustment()
          Return the total adjustment in FormattedMonetaryAmountDataBean.
  FormattedMonetaryAmountDataBean getFormattedTotalProduct()
          Return the total price in FormattedMonetaryAmountDataBean.
  OrderFulfillmentItemStatusDataBean getOrderFulfillmentItemStatusDataBean()
          Return OrderStatusItemDataBean for this order item
  OrderItemAdjustmentDataBean[] getOrderItemAdjustmentDataBeans()
          Returns the OrderItemAdjustments of this OrderItem.
  OrderItemAdjustmentDataBean[] getOrderItemAdjustmentDataBeans(java.lang.Integer anCalculationUsageId, java.lang.Integer anDisplayLevel)
          Returns the OrderItemAdjustments of this OrderItem, with the specified CalculationUsage and display level.
  OrderItemAdjustmentDataBean[] getOrderItemLevelDiscountOrderItemAdjustmentDataBeans()
          Returns the OrderItemAdjustments of this OrderItem, with CalculationUsage -1 (i.e.
  OrderItemDataBean[] getParentItems()
          Returns parent order items
 PersonalizationAttribute[] getPAttributes(java.lang.Integer theLanguageId)
          Gets the Personalization Attributes for the order item
  PriceDataBean getPerItemTotalPrice()
          Return the total price in PriceDataBean.
  PriceDataBean getPriceDataBean()
          Return the price in PriceDataBean.
  TypedProperty getRequestProperties()
          Returns request properties
 java.lang.Double getSelectionQuantity()
          Returns total quantity of selection items
  OrderItemDataBean[] getSiblingFinalItems()
          Returns "final" sibling order items
  OrderItemDataBean[] getSiblingInitialItems()
          Returns "initial" sibling order items
  OrderItemDataBean[] getSiblingItems(java.lang.String aRelType)
          Returns sibling order items
  OrderItemDataBean[] getSiblingSelectionItems()
          Returns "selection" sibling order items
  OrderItemDataBean[] getSiblingSubmissionItems()
          Returns "submission" sibling order items
 boolean hasPAttributes()
          Does the order item have any personalization attributes associated with it?
 void populate()
          Populates this databean with data retrieved from the database
 void setCatalogEntry( CatalogEntryAccessBean aabCatalogEntry)
          Sets catalog entry
 void setCatalogEntry( CatalogEntryDataBean adbCatalogEntry)
          Sets catalog entry
 void setCommandContext( CommandContext context)
          Sets the command context
 void setOrderItemId(java.lang.String orderItemId)
          Sets an order item id.
 void setRequestProperties( TypedProperty param)
          Sets request properties
 
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
Constructor Detail

OrderItemDataBean

public OrderItemDataBean()
OrderItemDataBean constructor comment.

OrderItemDataBean

public OrderItemDataBean(OrderItemAccessBean aabOrderItem,
CommandContext aCommandContext)
                  throws java.lang.Exception
Constructs an OrderItemDataBean from an OrderItemAccessBean by extracting the OrderItem EJB reference from the OrderItemAccessBean and setting the command context
Parameters:
aabOrderItem - OrderItemAccessBean
aCommandContext - CommandContext
Throws:
java.lang.Exception

OrderItemDataBean

public OrderItemDataBean(OrderItemAccessBean aabOrderItem)
                  throws java.lang.Exception
Constructs an OrderItemDataBean from an OrderItemAccessBean by extracting the OrderItem EJB reference from the OrderItemAccessBean.
Parameters:
aabOrderItem - OrderItemAccessBean
Throws:
java.lang.Exception
Method Detail

getApplicableContractId

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

getApplicableContractPrice

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

getCatalogEntry

public CatalogEntryAccessBean getCatalogEntry()
Returns CatalogEntryAccessBean
Returns:

getCatalogEntryDataBean

public CatalogEntryDataBean getCatalogEntryDataBean()
Returns CatalogEntryDataBean
Returns:

getCommandContext

public CommandContext getCommandContext()
Returns CommandContext
Returns:

getFormattedShippingCharge

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

getFormattedShippingTaxAmount

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

getFormattedTaxAmount

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

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:
Throws:
CreateException
FinderException
RemoteException
NamingException
ECSystemException

getFormattedTotalProduct

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

getPerItemTotalPrice

public PriceDataBean getPerItemTotalPrice()
Return the total price in PriceDataBean.
Returns:

getPriceDataBean

public PriceDataBean getPriceDataBean()
Return the price in PriceDataBean.
Returns:

getChildItems

public OrderItemDataBean[] getChildItems(java.lang.Integer[] aDistributorStoreIds,
                                         java.lang.String aLineItemType,
                                         java.lang.String aRelType)
Returns child order items for a list of distributors by LineItemType, and RelType LineItemType can be 'ALT','PRIM', or 'BOTH'
Parameters:
aDistributorStoreIds -
aLineItemType -
aRelType -
Returns:

getParentItems

public OrderItemDataBean[] getParentItems()
Returns parent order items
Returns:

getSiblingItems

public OrderItemDataBean[] getSiblingItems(java.lang.String aRelType)
Returns sibling order items
Parameters:
aRelType -
Returns:

getSiblingSelectionItems

public OrderItemDataBean[] getSiblingSelectionItems()
Returns "selection" sibling order items
Returns:

getSiblingFinalItems

public OrderItemDataBean[] getSiblingFinalItems()
Returns "final" sibling order items
Returns:

getSiblingInitialItems

public OrderItemDataBean[] getSiblingInitialItems()
Returns "initial" sibling order items
Returns:

getSiblingSubmissionItems

public OrderItemDataBean[] getSiblingSubmissionItems()
Returns "submission" sibling order items
Returns:

getSelectionQuantity

public java.lang.Double getSelectionQuantity()
Returns total quantity of selection items
Returns:

getRequestProperties

public TypedProperty getRequestProperties()
Returns request properties
Returns:

populate

public void populate()
              throws java.lang.Exception
Populates this databean with data retrieved from the database
Throws:
java.lang.Exception

setCatalogEntry

public void setCatalogEntry(CatalogEntryDataBean adbCatalogEntry)
Sets catalog entry
Parameters:
adbCatalogEntry - CatalogEntryDataBean

setCatalogEntry

public void setCatalogEntry(CatalogEntryAccessBean aabCatalogEntry)
                     throws java.lang.Exception
Sets catalog entry
Parameters:
aabCatalogEntry - CatalogEntryAccessBean
Throws:
java.lang.Exception

setCommandContext

public void setCommandContext(CommandContext context)
Sets the command context
Parameters:
context - CommandContext

setOrderItemId

public void setOrderItemId(java.lang.String orderItemId)
Sets an order item id.
Parameters:
orderItemId - String

setRequestProperties

public void setRequestProperties(TypedProperty param)
Sets request properties
Parameters:
param - TypedProperty

getChildAlternateSelectionItems

public OrderItemDataBean[] getChildAlternateSelectionItems()
Returns alternate selection child order items
Returns:

getChildPrimarySelectionItems

public OrderItemDataBean[] getChildPrimarySelectionItems()
Returns primary selection child order items
Returns:

getChildAlternateInitialItems

public OrderItemDataBean[] getChildAlternateInitialItems()
Returns alternate initial child order items
Returns:

getChildPrimaryInitialItems

public OrderItemDataBean[] getChildPrimaryInitialItems()
Returns primary initial child order items
Returns:

getChildAlternateSubmissionItems

public OrderItemDataBean[] getChildAlternateSubmissionItems()
Returns alternate submission child order items
Returns:

getChildPrimarySubmissionItems

public OrderItemDataBean[] getChildPrimarySubmissionItems()
Returns primary submission child order items
Returns:

getChildAlternateFinalItems

public OrderItemDataBean[] getChildAlternateFinalItems()
Returns alternate final child order items
Returns:

getChildPrimaryFinalItems

public OrderItemDataBean[] getChildPrimaryFinalItems()
Returns primary final child order items
Returns:

getChildAlternateSelectionItems

public OrderItemDataBean[] getChildAlternateSelectionItems(java.lang.Integer aStoreId,
                                                           java.lang.Long[] aContractIdList)
Returns alternate selection child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildPrimarySelectionItems

public OrderItemDataBean[] getChildPrimarySelectionItems(java.lang.Integer aStoreId,
                                                         java.lang.Long[] aContractIdList)
Returns primary selection child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildAlternateInitialItems

public OrderItemDataBean[] getChildAlternateInitialItems(java.lang.Integer aStoreId,
                                                         java.lang.Long[] aContractIdList)
Returns alternate initial child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildPrimaryInitialItems

public OrderItemDataBean[] getChildPrimaryInitialItems(java.lang.Integer aStoreId,
                                                       java.lang.Long[] aContractIdList)
Returns primary initial child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildAlternateSubmissionItems

public OrderItemDataBean[] getChildAlternateSubmissionItems(java.lang.Integer aStoreId,
                                                            java.lang.Long[] aContractIdList)
Returns alternate submission child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildPrimarySubmissionItems

public OrderItemDataBean[] getChildPrimarySubmissionItems(java.lang.Integer aStoreId,
                                                          java.lang.Long[] aContractIdList)
Returns primary submission child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildAlternateFinalItems

public OrderItemDataBean[] getChildAlternateFinalItems(java.lang.Integer aStoreId,
                                                       java.lang.Long[] aContractIdList)
Returns alternate final child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getChildPrimaryFinalItems

public OrderItemDataBean[] getChildPrimaryFinalItems(java.lang.Integer aStoreId,
                                                     java.lang.Long[] aContractIdList)
Returns primary final child order items by the specified proxy store and contract id(s) If aContractIdList is null, it will default to the default contract for the proxy store
Parameters:
aStoreId - Integer
aContractIdList - Long array
Returns:

getOrderFulfillmentItemStatusDataBean

public OrderFulfillmentItemStatusDataBean getOrderFulfillmentItemStatusDataBean()
Return OrderStatusItemDataBean for this order item
Returns:

hasPAttributes

public boolean hasPAttributes()
                       throws java.lang.Exception
Does the order item have any personalization attributes associated with it?
Returns:
true if the order item has personalization attributes; false otherwise
Throws:
java.lang.Exception

getPAttributes

public PersonalizationAttribute[] getPAttributes(java.lang.Integer theLanguageId)
                                          throws java.lang.Exception
Gets the Personalization Attributes for the order item
Parameters:
theLanguageId - The language Id to fetch any language specific data in.
Returns:
The array of personalization attributes.
Throws:
java.lang.Exception

getOrderItemAdjustmentDataBeans

public OrderItemAdjustmentDataBean[] getOrderItemAdjustmentDataBeans()
Returns the OrderItemAdjustments of this OrderItem.
Returns:
the OrderItemAdjustmentDataBeans, or null if none is found or an error has occurred during its retrieval.

getOrderItemAdjustmentDataBeans

public OrderItemAdjustmentDataBean[] getOrderItemAdjustmentDataBeans(java.lang.Integer anCalculationUsageId,
                                                                     java.lang.Integer anDisplayLevel)
Returns the OrderItemAdjustments of this OrderItem, 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 OrderItemAdjustmentDataBeans, or null if none is found or an error has occurred during its retrieval.

getOrderItemLevelDiscountOrderItemAdjustmentDataBeans

public OrderItemAdjustmentDataBean[] getOrderItemLevelDiscountOrderItemAdjustmentDataBeans()
Returns the OrderItemAdjustments of this OrderItem, with CalculationUsage -1 (i.e. discount) and display level 0 (i.e. OrderItem).
Returns:
the OrderItemAdjustmentDataBeans, or null if none is found or an error has occurred during its retrieval.

getFormattedQuantity

public java.lang.String getFormattedQuantity()
Returns the requested quantity formatted as a string with decimal separator only shown if there is a fractional portion.
Returns:
String representing the quantity