com.ibm.commerce.giftregistry.beans

Class GiftRegistryOrderItemDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.order.objects.OrderItemAccessBean

com.ibm.commerce.order.beansrc.OrderItemDataBeanBase

com.ibm.commerce.order.beans.OrderItemDataBean

com.ibm.commerce.giftregistry.beans.GiftRegistryOrderItemDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.order.beans.OrderItemInputDataBean, com.ibm.commerce.order.beans.OrderItemSmartDataBean, Delegator, java.io.Serializable

public class GiftRegistryOrderItemDataBean
extends OrderItemDataBean

Retrieve the order item and its registry information. Retrieve the address attributes of the ADDRESSID column with the status G, in the ORDERITEM database table.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.commerce.order.beans.OrderItemDataBean

OrderItemDataBean.AppliedPromotion

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.

Fields inherited from class com.ibm.commerce.order.beans.OrderItemDataBean

temp

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
GiftRegistryOrderItemDataBean() GiftRegistryOrderItemDataBean constructor.
GiftRegistryOrderItemDataBean(OrderItemDataBean adbOrderItem) Constructs an GiftRegistryOrderItemDataBean from an OrderItemDataBean
GiftRegistryOrderItemDataBean(OrderItemDataBean adbOrderItem, CommandContext aCommandContext) Constructs an GiftRegistryOrderItemDataBean from an OrderItemAccessBean and sets the command context

Method Summary

Modifier and Type	Method and Description
AddressDataBean	getAddressDataBean() Gets AddressDataBean.
java.lang.String	getExternalGiftRegistryId() Gets the external ID associated with the order item.
java.lang.String	getGiftMessage() Gets the gift message
GiftRegistryDataBean	getGiftRegistryDB() Gets the gift registry data bean
java.lang.String	getShipToRegistrant() Check whether Ship To Registrant is specified.
void	populate() Populates this data bean with data retrieved from the database

Methods inherited from class com.ibm.commerce.order.beans.OrderItemDataBean

getAdjustmentTotal, getAllowableShippingAddressDataBeans, getAllowableShippingModeDataBeans, getApplicableContractId, getApplicableContractPrice, getAppliedProductPromotions, getCatalogEntry, getCatalogEntryDataBean, getChildAlternateFinalItems, getChildAlternateFinalItems, getChildAlternateInitialItems, getChildAlternateInitialItems, getChildAlternateSelectionItems, getChildAlternateSelectionItems, getChildAlternateSubmissionItems, getChildAlternateSubmissionItems, getChildItems, getChildPrimaryFinalItems, getChildPrimaryFinalItems, getChildPrimaryInitialItems, getChildPrimaryInitialItems, getChildPrimarySelectionItems, getChildPrimarySelectionItems, getChildPrimarySubmissionItems, getChildPrimarySubmissionItems, getCommandContext, getCurrentAddressDataBean, getDelegate, getDiscountAdjustmentTotal, getFormattedEstimatedAvailableTime, getFormattedEstimatedShippingTime, getFormattedQuantity, getFormattedRequestedShipDate, getFormattedShippingCharge, getFormattedShippingTaxAmount, getFormattedTaxAmount, getFormattedTotalAdjustment, getFormattedTotalDiscountAdjustment, getFormattedTotalProduct, getFormattedTotalShippingAdjustment, getFormattedTotalShippingCharge, getFormattedTotalSurchargeAdjustment, getItemDataBean, getOrderFulfillmentItemStatusDataBean, getOrderItemAdjustmentDataBeans, getOrderItemAdjustmentDataBeans, getOrderItemLevelDiscountOrderItemAdjustmentDataBeans, getOrderItemLevelShippingOrderItemAdjustmentDataBeans, getOrderItemLevelSurchargeOrderItemAdjustmentDataBeans, getParentItems, getPAttributes, getPerItemTotalPrice, getPriceDataBean, getQuantityInIntValue, getRequestedShipDateDay, getRequestedShipDateMonth, getRequestedShipDateYear, getRequestProperties, getReturnInformationDataBean, getRootOICompRelDataBean, getSelectionQuantity, getSerialNumbers, getSerialNumbersForComponents, getSerialNumbersForOrderItem, getShipCarrAccntDataBean, getShipInstructsDataBean, getShipmentInformationDataBeans, getShippingAdjustmentTotal, getShippingChargeTotal, getShippingModeDataBean, getShippingModeDescriptionDataBean, getShortDescription, getSiblingFinalItems, getSiblingInitialItems, getSiblingItems, getSiblingSelectionItems, getSiblingSubmissionItems, getSurchargeAdjustmentTotal, getTotalAdjustmentByCalculationUsageId, getTotalAdjustmentByCalculationUsageIdAndDisplayLevel, getTotalAdjustmentByDisplayLevel, hasPAttributes, isBackOrdered, isDiscontinued, isEditable, isExpedited, isFree, isInventoryAvailable, isPersonalAddressAllowForShipping, isReturnable, main, populateAppliedProductPromotion, setCatalogEntry, setCatalogEntry, setCommandContext, setOrderItemId, setRequestProperties

Methods inherited from class com.ibm.commerce.order.objects.OrderItemAccessBean

findByCatalogEntryId, findByMemberCatalogEntryAndStore, findByMemberStoreAndStatus, findByOfferId, findByOrder, findByOrderAndFulfillmentStatus, findByOrderAndFulfillmentStatusForUpdate, findByOrderAndMember, findByOrderAndMemberForUpdate, findByOrderAndReleaseAndFilfillmentStatusNotShip, findByOrderForUpdate, findByOrderIdAddressIdShipModeId, findByOrderIds, findByOrderIds, findByOrderIdsAndATPCodes, findByOrderIdShipModeId, findByOrderItemIds, findByOrderReleaseNumAndOrdersId, findByOrdersIdAndInventoryStatusAndFulfillmentStatus, findByOrderSortedByCatalogEntryId, findByOrderSortedByOrderItemId, findByTradingId, findChildOrderItemsByDistributorsAndOrdersIdAndLineItemTypeAndRelTypeAndCorr, findInvalidlyAllocatedAndBackorderedItemsByOrdersId, findInvalidOrderItemsByOrdersId, findParentOrderItemsByOrdersIdAndCorr, findPendingOrderItemsByMemberAndAddress, findPendingOrderItemsByMemberCatalogEntryAndStore, findPendingOrderItemsForMember, findSiblingOrderItemsByOrdersIdAndRelTypeAndCorr, findWithParameterizedPushDownQuery, findWithPushDownQuery, getAddressId, getAddressIdInEntityType, getAdjustmentSum, getAllocatedFulfillmentCenterId, getAllocatedFulfillmentCenterIdInEntityType, getAllocatedQuantity, getAllocatedQuantityInEntityType, getAllocationAddressId, getAllocationAddressIdInEntityType, getAllocationGroup, getAllocationGroupInEntityType, getAttachedDiscountOrShippingCalculationCodes, getAvailableQuantity, getAvailableQuantityInEntityType, getBasePrice, getBasePriceCurrency, getBasePriceInEntityType, getCatalogEntryId, getCatalogEntryIdInEntityType, getCategoryTaxAmount, getCategoryTaxAmounts, getComment, getConfigurationComponents, getConfigurationId, getContractId, getContractIdInEntityType, getCorrelationGroup, getCorrelationGroupInEntityType, getCurrency, getDescription, getEntity, getEstimatedAvailableTime, getEstimatedAvailableTimeInEntityType, getEstimatedOrPromisedShippingTime, getEstimatedShippingTime, getField1, getField1InEntityType, getField2, getFulfillmentCenterId, getFulfillmentCenterIdInEntityType, getFulfillmentStatus, getInventoryStatus, getIsExpedited, getItemSpecId, getItemSpecIdInEntityType, getLastAllocatedUpdate, getLastAllocatedUpdateInEntityType, getLastUpdate, getLastUpdateInEntityType, getLineItemType, getMemberId, getMemberIdInEntityType, getNeededQuantity, getNeededQuantityInEntityType, getOffer, getOfferId, getOfferIdInEntityType, getOrder, getOrderId, getOrderIdInEntityType, getOrderItemId, getOrderItemIdInEntityType, getOrderReleaseNumber, getOrderReleaseNumberInEntityType, getOutputqID, getOutputqIDInEntityType, getPartNumber, getPrepareFlags, getPrepareFlagsInEntityType, getPrice, getPriceInEntityType, getPromisedAvailableTime, getPromisedAvailableTimeInEntityType, getPromisedShippingTime, getQuantity, getQuantityInEntityType, getRequestedShipDate, getResolvedDescription, getShippingCharge, getShippingChargeInEntityType, getShippingMode, getShippingModeId, getShippingModeIdInEntityType, getShippingOffset, getShippingOffsetInEntityType, getShippingTaxAmount, getShippingTaxAmountInEntityType, getStatus, getStoreId, getStoreIdInEntityType, getSupplierData, getSupplierPartNumber, getTaxAmount, getTaxAmountInEntityType, getTermAndConditionId, getTermAndConditionIdInEntityType, getTieCode, getTimeCreated, getTimeCreatedInEntityType, getTimeReleased, getTimeReleasedInEntityType, getTimeShipped, getTimeShippedInEntityType, getTotalAdjustment, getTotalAdjustmentInEntityType, getTotalProduct, getTotalProductInEntityType, getTrackingDate, getTrackingDateInEntityType, getTrackingIds, getTrackingNumber, instantiateEntity, remove, resetAllCategoryTaxes, resetCategoryTax, setAddressId, setAddressId, setAllocatedFulfillmentCenterId, setAllocatedFulfillmentCenterId, setAllocatedQuantity, setAllocatedQuantity, setAllocationAddressId, setAllocationAddressId, setAllocationGroup, setAllocationGroup, setAndGetNonNullCorrelationGroup, setAvailableQuantity, setAvailableQuantity, setBasePrice, setBasePrice, setBasePriceCurrency, setCatalogEntryId, setCatalogEntryId, setCategoryTaxAmount, setCategoryTaxAmounts, setComment, setConfigurationId, setContractId, setContractId, setCorrelationGroup, setCorrelationGroup, setCurrency, setDescription, setEstimatedAvailableTime, setEstimatedAvailableTime, setField1, setField1, setField2, setFulfillmentCenterId, setFulfillmentCenterId, setFulfillmentStatus, setInitKey_orderItemId, setInitKey_orderItemId, setInventoryStatus, setIsExpedited, setItemSpecId, setItemSpecId, setLastAllocatedUpdate, setLastAllocatedUpdate, setLastUpdate, setLastUpdate, setLineItemType, setMemberId, setMemberId, setNeededQuantity, setNeededQuantity, setOfferId, setOfferId, setOrderId, setOrderId, setOrderReleaseNumber, setOrderReleaseNumber, setOutputqID, setOutputqID, setPartNumber, setPrepareFlags, setPrepareFlags, setPrice, setPrice, setPromisedAvailableTime, setPromisedAvailableTime, setQuantity, setQuantity, setRequestedShipDate, setShippingCharge, setShippingCharge, setShippingModeId, setShippingModeId, setShippingOffset, setShippingOffset, setShippingTaxAmount, setShippingTaxAmount, setStatus, setStoreId, setStoreId, setSupplierData, setSupplierPartNumber, setTaxAmount, setTaxAmount, setTermAndConditionId, setTermAndConditionId, setTieCode, setTimeCreated, setTimeCreated, setTimeReleased, setTimeReleased, setTimeShipped, setTimeShipped, setTotalAdjustment, setTotalAdjustment, setTotalProduct, setTotalProduct, setTrackingDate, setTrackingDate, setTrackingNumber

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, setUseDataCache, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

Constructor Detail

GiftRegistryOrderItemDataBean

public GiftRegistryOrderItemDataBean()

GiftRegistryOrderItemDataBean constructor.

GiftRegistryOrderItemDataBean

public GiftRegistryOrderItemDataBean(OrderItemDataBean adbOrderItem)

Constructs an GiftRegistryOrderItemDataBean from an OrderItemDataBean

Parameters:

adbOrderItem - OrderItemDataBean

Throws:

java.lang.Exception

GiftRegistryOrderItemDataBean

public GiftRegistryOrderItemDataBean(OrderItemDataBean adbOrderItem,
                                     CommandContext aCommandContext)

Constructs an GiftRegistryOrderItemDataBean from an OrderItemAccessBean and sets the command context

Parameters:

adbOrderItem - OrderItemDataBean

aCommandContext - CommandContext

Throws:

java.lang.Exception

Method Detail

populate

public void populate()
              throws java.lang.Exception

Populates this data bean with data retrieved from the database

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class OrderItemDataBean

Throws:

java.lang.Exception

See Also:

OrderItemDataBean.setOrderItemId(String)

getExternalGiftRegistryId

public java.lang.String getExternalGiftRegistryId()

Gets the external ID associated with the order item.

Returns:

The external ID - the unique gift registry identifier.
Note: return null if the order item is not associated with a registry.

getGiftMessage

public java.lang.String getGiftMessage()

Gets the gift message

Returns:

The gift message

getShipToRegistrant

public java.lang.String getShipToRegistrant()

Check whether Ship To Registrant is specified.

Returns:

String
1: if ORDERITEMGIFT.SHIPTORGSTRNT = 1
0: if ORDERITEMGIFT.SHIPTORGSTRNT is set to 0
null: if ORDERITEMGIFT.SHIPTORGSTRNT is not set

getGiftRegistryDB

public GiftRegistryDataBean getGiftRegistryDB()

Gets the gift registry data bean

Returns:

the gift registry data bean

getAddressDataBean

public AddressDataBean getAddressDataBean()

Gets AddressDataBean. If the address status is G, then the ship to registrant returns the GRAddressDataBean() constructor. If the address status is not G, then returns super.getAddressDataBean()

Overrides:

getAddressDataBean in class OrderItemDataBean

Returns:

AddressDataBean for the addressId passed in.