Package de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf

Interface Order

All Superinterfaces:

BusinessObject, java.lang.Iterable<Item>, MessageListHolder, SalesDocument, SalesDocumentBase<ItemList,Item,Header>, java.io.Serializable, SimpleDocument<ItemList,Item,Header>

All Known Implementing Classes:

OrderHistoryImpl, OrderImpl

public interface Order
extends SalesDocument

Business object representation of an Order.
The order extends the SalesDocument business object.
There can be several orders per session existent. All back ends require a login to access an order.

See Also:

SalesDocument

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	destroyContent()	Destroys content in BusinessObject layer and application memory of the back end.
TechKey	getBasketId()	Returns the TechKey of the basket used for creating this order.
boolean	isCancelable()	Checks if the order is cancelable
boolean	saveOrderAndCommit()	Saves the order in the back end and commits.
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 interface de.hybris.platform.sap.core.bol.businessobject.BusinessObject

addExtensionData, clearMessages, clearOwnMessages, copyMessages, copyMessages, createUniqueHandle, destroy, 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, saveAndCommit, 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

Method Detail

getBasketId

TechKey getBasketId()

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

Returns:

TechKey of Basket

setBasketId

void setBasketId(TechKey basketId)

Sets the TechKey of basket used for creating this order. The TechKey is stored as a reference to the basket.

Parameters:

basketId - TechKey of the basket

destroyContent

void destroyContent()
             throws CommunicationException

Destroys content in BusinessObject layer and application memory of the back end. Only the already persisted content remains. For example: An order which is not yet submitted and for which destroyContent is called, will be deleted from application memory. An Order which is already submitted (e.g. via checkout), destroyContent will only invalidate the BusinessObject but not the back end representation.

Specified by:

destroyContent in interface SalesDocument

Throws:

CommunicationException - in case back-end error

saveOrderAndCommit

boolean saveOrderAndCommit()
                    throws CommunicationException

Saves the order in the back end and commits. Changes will be persisted.

Returns:

true if the save and commit were successful

Throws:

CommunicationException - in case of a back-end error

setLoadStateCreate

void setLoadStateCreate()
                 throws BusinessObjectException

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

Throws:

BusinessObjectException - in case of a back-end error

isCancelable

boolean isCancelable()
              throws CommunicationException

Checks if the order is cancelable

Returns:

true if order is cancelable

Throws:

CommunicationException - in case of a back-end error