atg.projects.store.order
Class StoreOrderImpl

java.lang.Object
  atg.commerce.order.CommerceIdentifierImpl
      atg.commerce.order.OrderImpl
          atg.projects.store.order.StoreOrderImpl

All Implemented Interfaces:

atg.commerce.order.ChangedProperties, atg.commerce.order.CommerceIdentifier, atg.commerce.order.CommerceItemContainer, atg.commerce.order.CostCenterContainer, atg.commerce.order.CostCenterRelationshipContainer, atg.commerce.order.Order, atg.commerce.order.PaymentGroupContainer, atg.commerce.order.PaymentGroupRelationshipContainer, atg.commerce.order.RelationshipContainer, atg.commerce.order.ShippingGroupContainer, java.io.Serializable, java.util.Observer

public class StoreOrderImpl
extends atg.commerce.order.OrderImpl

Extension to order class.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/order/StoreOrderImpl.java#2 $

Author:

ATG

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	GIFT_MESSAGE_FROM_KEY Gift message from key name.
static java.lang.String	GIFT_MESSAGE_KEY Gift message key name.
static java.lang.String	GIFT_MESSAGE_TO_KEY Gift message to key name.
static java.lang.String	SAMPLE_COMMERCE_ITEM_TYPE Sample commerce item type.

Fields inherited from class atg.commerce.order.OrderImpl

mCommerceItemContainer, mCostCenterContainer, mCostCenterRelationshipContainer, mInitialized, mInvalidated, mPaymentGroupContainer, mPaymentGroupRelationshipContainer, mRelationshipContainer, mShippingGroupContainer

Constructor Summary

StoreOrderImpl()

Method Summary

void	addOmsSegment(java.lang.String pOmsSegment) Sets the OMS segments.
boolean	getContainsGiftMessage() Checks to see if this order has a gift message special instruction.
boolean	getContainsGiftWrap() Checks to see if this order is gift wrapped or not.
boolean	getGiftMessagePopulated() Determines if user has entered gift message.
GiftWrapCommerceItem	getGiftWrapItem() Returns gift wrap commerce item.
java.lang.String	getOmsOrderId()
java.util.List	getOmsSegments()
long	getOriginalTotalItemsCount() Returns original total count of commerce items in the order at the point when the order has been submitted.
double	getStoreCreditsAppliedTotal() This is a read-only property getter.
long	getTotalReturnedItemsCount() Returns total count of returned items in the order.
boolean	isShouldAddGiftNote()
boolean	removeAddress(java.lang.String pShippingGroupId) Removes an Address associated with this orders shipping group.
void	removeAllOmsSegments() Removes all OMS segments from order.
void	setGiftMessage(java.lang.String pMessageTo, java.lang.String pMessage, java.lang.String pMessageFrom) Sets the gift message.
void	setOmsOrderId(java.lang.String pOmsId) Sets the SAP order id.
void	setShouldAddGiftNote(boolean pShouldAddGiftNote)
java.lang.String	toString() Method that renders the general order information in a readable string format.

Methods inherited from class atg.commerce.order.OrderImpl

addChangedProperty, addCommerceItem, addCommerceItem, addCostCenter, addCostCenter, addCostCenterRelationship, addCostCenterRelationship, addOrderIdToRelatedOrders, addPaymentGroup, addPaymentGroup, addPaymentGroupRelationship, addPaymentGroupRelationship, addRelationship, addRelationship, addShippingGroup, addShippingGroup, clearChangedProperties, ensureContainers, equals, getAgentId, getApprovalSystemMessages, getApproverIds, getApproverMessages, getAuthorizedApproverIds, getChangedProperties, getCommerceItem, getCommerceItemCount, getCommerceItems, getCommerceItemsByCatalogRefId, getCompletedDate, getCompletedTime, getCostCenter, getCostCenterCount, getCostCenterRelationship, getCostCenterRelationshipCount, getCostCenterRelationships, getCostCenters, getCreatedByOrderId, getCreationDate, getCreationSiteId, getCreationTime, getDescription, getLastModifiedDate, getLastModifiedTime, getManualAdjustments, getOrderClassType, getOriginOfOrder, getPaymentGroup, getPaymentGroupCount, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, getPaymentGroups, getPriceInfo, getPriceInfoRepositoryItem, getProfileId, getPropertyValue, getRelatedOrders, getRelationship, getRelationshipCount, getRelationships, getRepositoryItem, getSalesChannel, getSaveAllProperties, getShippingGroup, getShippingGroupCount, getShippingGroups, getSiteId, getSpecialInstructions, getState, getStateAsString, getStateAsUserResource, getStateDetail, getStateDetailAsUserResource, getSubmittedDate, getSubmittedTime, getTaxPriceInfo, getTaxPriceInfoRepositoryItem, getTotalCommerceItemCount, getVersion, hashCode, invalidateOrder, isChanged, isExplicitlySaved, isTransient, preEnsureContainers, removeAllCommerceItems, removeAllCostCenterRelationships, removeAllCostCenters, removeAllPaymentGroupRelationships, removeAllPaymentGroups, removeAllRelationships, removeAllShippingGroups, removeCommerceItem, removeCostCenter, removeCostCenterRelationship, removePaymentGroup, removePaymentGroupRelationship, removeRelationship, removeShippingGroup, repositionCommerceItem, setAgentId, setApprovalSystemMessages, setApproverIds, setApproverMessages, setAuthorizedApproverIds, setChanged, setCompletedDate, setCompletedTime, setCreatedByOrderId, setCreationDate, setCreationSiteId, setCreationTime, setDescription, setExplicitlySaved, setLastModifiedDate, setLastModifiedTime, setManualAdjustments, setOrderClassType, setOriginOfOrder, setPriceInfo, setPriceInfoRepositoryItem, setProfileId, setPropertyValue, setRepositoryItem, setSalesChannel, setSaveAllProperties, setSiteId, setSpecialInstructions, setState, setStateAsString, setStateDetail, setSubmittedDate, setSubmittedTime, setTaxPriceInfo, setTaxPriceInfoRepositoryItem, setTransient, setVersion, update, updateVersion

Methods inherited from class atg.commerce.order.CommerceIdentifierImpl

getId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

GIFT_MESSAGE_TO_KEY

public static final java.lang.String GIFT_MESSAGE_TO_KEY

Gift message to key name.

See Also:

Constant Field Values

GIFT_MESSAGE_KEY

public static final java.lang.String GIFT_MESSAGE_KEY

Gift message key name.

See Also:

Constant Field Values

GIFT_MESSAGE_FROM_KEY

public static final java.lang.String GIFT_MESSAGE_FROM_KEY

Gift message from key name.

See Also:

Constant Field Values

SAMPLE_COMMERCE_ITEM_TYPE

public static final java.lang.String SAMPLE_COMMERCE_ITEM_TYPE

Sample commerce item type.

See Also:

Constant Field Values

Constructor Detail

StoreOrderImpl

public StoreOrderImpl()

Method Detail

isShouldAddGiftNote

public boolean isShouldAddGiftNote()

Returns:

the mShouldAddGiftNote

setShouldAddGiftNote

public void setShouldAddGiftNote(boolean pShouldAddGiftNote)

Parameters:

pShouldAddGiftNote - the shouldAddGiftNote to set

getOmsOrderId

public java.lang.String getOmsOrderId()

Returns:

the SAP order id.

setOmsOrderId

public void setOmsOrderId(java.lang.String pOmsId)

Sets the SAP order id.

Parameters:

pOmsId - - the SAP order id

getOmsSegments

public java.util.List getOmsSegments()

Returns:

list of OMS segments.

addOmsSegment

public void addOmsSegment(java.lang.String pOmsSegment)

Sets the OMS segments.

Parameters:

pOmsSegment - - list of OMS segments.

removeAllOmsSegments

public void removeAllOmsSegments()

Removes all OMS segments from order.

getContainsGiftWrap

public boolean getContainsGiftWrap()

Checks to see if this order is gift wrapped or not.

Returns:

true if gift wrapped, otherwise false.

getGiftWrapItem

public GiftWrapCommerceItem getGiftWrapItem()

Returns gift wrap commerce item.

Returns:

gift wrap item if found, otherwise null.

getContainsGiftMessage

public boolean getContainsGiftMessage()

Checks to see if this order has a gift message special instruction.

Returns:

true if order contains gift message, otherwise false.

setGiftMessage

public void setGiftMessage(java.lang.String pMessageTo,
                           java.lang.String pMessage,
                           java.lang.String pMessageFrom)

Sets the gift message.

Parameters:

pMessageTo - - the message to field.

pMessage - - the message field.

pMessageFrom - - the message from field.

getGiftMessagePopulated

public boolean getGiftMessagePopulated()

Determines if user has entered gift message.

Returns:

true if gift message was populated, otherwise false.

getStoreCreditsAppliedTotal

public double getStoreCreditsAppliedTotal()

This is a read-only property getter.
storeCreditsAppliedTotal property contains total amount of store credits applied to the current order.

Returns:

order's store credits amount.

getTotalReturnedItemsCount

public long getTotalReturnedItemsCount()

Returns total count of returned items in the order.

Returns:

total count of returned items in the order.

getOriginalTotalItemsCount

public long getOriginalTotalItemsCount()

Returns original total count of commerce items in the order at the point when the order has been submitted. That count includes already returned items count.

Returns:

original total count of commerce items including already returned items.

removeAddress

public boolean removeAddress(java.lang.String pShippingGroupId)

Removes an Address associated with this orders shipping group.

Parameters:

pShippingGroupId - - The shipping groups id from which to remove the address.

Returns:

A boolean indicating success or failure.

toString

public java.lang.String toString()

Method that renders the general order information in a readable string format.

Overrides:

toString in class atg.commerce.order.OrderImpl

Returns:

string representation of the class.