Package de.hybris.platform.sap.sapordermgmtbol.transaction.order.businessobject.impl

Class OrderImpl

java.lang.Object

de.hybris.platform.sap.core.bol.businessobject.BusinessObjectBase

de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.impl.SimpleDocumentImpl<L,I,H>

de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.impl.SalesDocumentBaseImpl<ItemList,Item,Header>

de.hybris.platform.sap.sapordermgmtbol.transaction.salesdocument.businessobject.impl.SalesDocumentImpl

de.hybris.platform.sap.sapordermgmtbol.transaction.order.businessobject.impl.OrderImpl

All Implemented Interfaces:

BackendAware, BusinessObject, MessageListHolder, Order, SalesDocument, SalesDocumentBase<ItemList,Item,Header>, SimpleDocument<ItemList,Item,Header>, Serializable, Cloneable, Iterable<Item>

Direct Known Subclasses:

OrderHistoryImpl

public class OrderImpl
extends SalesDocumentImpl
implements Order

Class representing the BOL order.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SalesDocumentBackend	backendServiceGuest	Backend service / guest scenario
static final Log4JWrapper	sapLogger	reference to SAP logging API

Fields inherited from class de.hybris.platform.sap.sapordermgmtbol.transaction.salesdocument.businessobject.impl.SalesDocumentImpl

alreadyInitialized, backendService, checkCatalogNecessary, determinationRequired, externalToOrder, grossValueAvailable, itemsWithAlternativeProductList, netValueAvailable, pricesTraced, redemptionValue, transactionConfiguration

Fields inherited from class de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.impl.SalesDocumentBaseImpl

billToList, changeHeaderOnly, persistentInBackend, shipToList

Fields inherited from class de.hybris.platform.sap.core.bol.businessobject.BusinessObjectBase

backendObject, backendType, bobMessages, bobState, extensionData, genericFactory, handle, moduleConfigurationAccess, techKey

Fields inherited from interface de.hybris.platform.sap.core.common.message.MessageListHolder

INVALID, VALID

Fields inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.SalesDocumentBase

NO_OF_ITEMS_UNKNOWN

Constructor Summary

Constructors

Constructor	Description
OrderImpl()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Makes a copy of the object.
void	destroy()	Method will be called by the BusinessObjectManager when the end of the life cycle is reached, so that all used resources can be released.
void	destroyContent()	Destroy the data of the document (items and header) in the backend representation.
protected SalesDocumentBackend	getBackendService()	Method retrieving the backend object for the object.
TechKey	getBasketId()	Returns the TechKey of the basket used for creating this order.
boolean	isCancelable()	Checks if the order is cancelable
boolean	saveAndCommit()	Saves the order in the backend.
boolean	saveOrderAndCommit()	Saves the order in the backend.
void	setBackendService(OrderBackend service)	This method can be used to set a fixed back end service (e.g.
void	setBasketId(TechKey basketId)	Sets the TechKey of basket used for creating this order
void	setLoadStateCreate()	Sets the creation mode of LO-API.

Methods inherited from class de.hybris.platform.sap.sapordermgmtbol.transaction.salesdocument.businessobject.impl.SalesDocumentImpl

adaptHeaderDocumentType, addShipTo, afterDeleteItemInBackend, afterDeleteItemInBackend, afterUpdateItemInBackend, clearItemBuffer, clearShipTos, createBillTo, createInBackend, createItem, createItemKey, createShipTo, deleteItemInt, determineConfigurableItemsToRelease, emptyContent, getDocumentType, getDublicatesForItems, getSalesDocumentHooks, getSessionService, getSoldToGuid, getTransactionConfiguration, hasPredecessorOfSpecificType, init, init, init, isBackendDown, isCheckCatalogNecessary, isDeterminationRequired, isExistingInBackend, isExternalToOrder, isGrossValueAvailable, isInitialized, isItemBasedAvailability, isMultipleAddressesSupported, isNetValueAvailable, isUpdateMissing, mergeIdenticalProducts, mergeIdenticalProductsIfRequired, mergingItem, prepareItemsWithChangedProducts, processItems, read, read, readForUpdate, readForUpdate, removeItem, removeItems, setBillToList, setCheckCatalogNecessary, setConverter, setDeterminationRequired, setExternalToOrder, setGrossValueAvailable, setInitialized, setNetValueAvailable, setSalesDocumentHooks, setSessionService, setShipToList, setSoldToGuid, setSoldToGuid, setTransactionConfiguration, setUpdateMissing, toString, update, updateInBackend, validate

Methods inherited from class de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.impl.SalesDocumentBaseImpl

clear, getAlternativeBillTos, getAlternativeShipTos, isChangeHeaderOnly, isPersistentInBackend, setPersistentInBackend

Methods inherited from class de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.impl.SimpleDocumentImpl

addItem, clearHeader, clearItems, clearMessages, getApplicationId, getChangeDate, getHeader, getItem, getItemList, getTypedExtensionMap, getVersion, isDirty, iterator, setApplicationId, setChangeDate, setDirty, setHeader, setItemList, setTechKey, setVersion

Methods inherited from class de.hybris.platform.sap.core.bol.businessobject.BusinessObjectBase

addExtensionData, addMessage, clearMessages, clearOwnMessages, copyMessages, copyMessages, createUniqueHandle, determineBackendObject, equals, getBackendBusinessObject, getBackendBusinessObject, getBackendType, getExtensionData, getExtensionDataValues, getExtensionMap, getHandle, getMessageList, getModuleConfigurationAccess, getOwnMessageList, getSubObjectIterator, getTechKey, hasHandle, hashCode, hasMessages, hasOwnMessages, init, isValid, logMessage, removeExtensionData, removeExtensionDataValues, setBackendObject, setBackendType, setExtensionMap, setGenericFactory, setHandle, setInvalid, setModuleConfigurationAccess, setValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.sap.core.bol.businessobject.BusinessObject

addExtensionData, clearMessages, clearOwnMessages, copyMessages, copyMessages, createUniqueHandle, getExtensionData, getExtensionDataValues, getExtensionMap, getHandle, getOwnMessageList, getSubObjectIterator, getTechKey, hasHandle, hasMessages, hasOwnMessages, init, isValid, logMessage, removeExtensionData, removeExtensionDataValues, setExtensionMap, setHandle, setInvalid, setTechKey, setValid

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface de.hybris.platform.sap.core.common.message.MessageListHolder

addMessage, clearMessages, getMessageList

Methods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.SalesDocument

afterDeleteItemInBackend, clearItemBuffer, clearShipTos, createBillTo, createItem, createShipTo, getDocumentType, getTransactionConfiguration, hasPredecessorOfSpecificType, init, init, isBackendDown, isCheckCatalogNecessary, isExistingInBackend, isExternalToOrder, isGrossValueAvailable, isInitialized, isItemBasedAvailability, isMultipleAddressesSupported, isNetValueAvailable, isUpdateMissing, read, read, readForUpdate, readForUpdate, removeItem, removeItems, setBillToList, setCheckCatalogNecessary, setConverter, setExternalToOrder, setGrossValueAvailable, setInitialized, setNetValueAvailable, setShipToList, setSoldToGuid, setTransactionConfiguration, setUpdateMissing, update, validate

Methods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.SalesDocumentBase

getAlternativeBillTos, getAlternativeShipTos, isChangeHeaderOnly, isDeterminationRequired, isPersistentInBackend, setDeterminationRequired, setPersistentInBackend

Methods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.SimpleDocument

addItem, clear, clearHeader, clearItems, getApplicationId, getChangeDate, getHeader, getItem, getItemList, getSoldToGuid, getTypedExtensionMap, getVersion, isDirty, setApplicationId, setChangeDate, setDirty, setHeader, setItemList, setSoldToGuid, setVersion

Field Details

backendServiceGuest

protected SalesDocumentBackend backendServiceGuest

Backend service / guest scenario

sapLogger

public static final Log4JWrapper sapLogger

reference to SAP logging API

Constructor Details

OrderImpl

public OrderImpl()

Method Details

getBasketId

public TechKey getBasketId()

Returns the TechKey of the basket used for creating this order.

Specified by:

getBasketId in interface Order

Returns:

TechKey of Basket

setBasketId

public void setBasketId(TechKey basketId)

Sets the TechKey of basket used for creating this order

Specified by:

setBasketId in interface Order

Parameters:

basketId - TechKey of the basket

saveAndCommit

public boolean saveAndCommit()
                      throws CommunicationException

Saves the order in the backend.

Specified by:

saveAndCommit in interface SalesDocument

Specified by:

saveAndCommit in class SalesDocumentImpl

Returns:

true if the save and commit was successful

Throws:

CommunicationException

saveOrderAndCommit

public boolean saveOrderAndCommit()
                           throws CommunicationException

Saves the order in the backend.

Specified by:

saveOrderAndCommit in interface Order

Returns:

true if the save and commit were successful

Throws:

CommunicationException - in case of a back-end error

destroyContent

public void destroyContent()
                    throws CommunicationException

Description copied from interface: SalesDocument

Destroy the data of the document (items and header) in the backend representation. After a call to this method, the object is in an undefined state. You have to call init() before you can use it again.
This method is normally called before removing the BO-representation of the object using the BOM.

Specified by:

destroyContent in interface Order

Specified by:

destroyContent in interface SalesDocument

Overrides:

destroyContent in class SalesDocumentImpl

Throws:

CommunicationException - in case back-end error

getBackendService

protected SalesDocumentBackend getBackendService()
                                          throws BackendException

Description copied from class: SalesDocumentImpl

Method retrieving the backend object for the object. This method is abstract because every concrete subclass of SalesDocument may use its own implementation of a backend object.

Specified by:

getBackendService in class SalesDocumentImpl

Returns:

Backend object to be used

Throws:

BackendException

setBackendService

public void setBackendService(OrderBackend service)

This method can be used to set a fixed back end service (e.g. mock it)

Parameters:

service - back end service to be used by this order

setLoadStateCreate

public void setLoadStateCreate()
                        throws BusinessObjectException

Description copied from interface: Order

Sets the creation mode of LO-API. It is only used in ERP scenario.

Specified by:

setLoadStateCreate in interface Order

Throws:

BusinessObjectException - in case of a back-end error

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: BusinessObjectBase

Makes a copy of the object. The MessageList is copied.

Overrides:

clone in class BusinessObjectBase

Returns:

a copy of object

Throws:

CloneNotSupportedException - CloneNotSupportedException

destroy

public void destroy()

Description copied from class: SalesDocumentBaseImpl

Method will be called by the BusinessObjectManager when the end of the life cycle is reached, so that all used resources can be released.

Specified by:

destroy in interface BusinessObject

Overrides:

destroy in class SalesDocumentImpl

isCancelable

public boolean isCancelable()
                     throws CommunicationException

Description copied from interface: Order

Checks if the order is cancelable

Specified by:

isCancelable in interface Order

Returns:

true if order is cancelable

Throws:

CommunicationException - in case of a back-end error