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

Interface Basket

All Superinterfaces:

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

All Known Implementing Classes:

BasketImpl

public interface Basket
extends SalesDocument

Business object representation of a basket.
The basket extends the SalesDocument business object.
There will be always exactly one basket per session. Depending on the back end a login may be required to access the basket.

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
java.math.BigDecimal	calculateTotalQuantity()
void	read(boolean force)	Reads the sales document.
void	release()	Releases cart object.
void	setBasketOrderConsistency(BasketOrderConsistency basketOrderConsistency)	Injects the basketOrderConsisteny into the basket

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, destroyContent, getDocumentType, getTransactionConfiguration, hasPredecessorOfSpecificType, init, init, isBackendDown, isCheckCatalogNecessary, isExistingInBackend, isExternalToOrder, isGrossValueAvailable, isInitialized, isItemBasedAvailability, isMultipleAddressesSupported, isNetValueAvailable, isUpdateMissing, 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

setBasketOrderConsistency

void setBasketOrderConsistency(BasketOrderConsistency basketOrderConsistency)

Injects the basketOrderConsisteny into the basket

Parameters:

basketOrderConsistency - consistency manager

read

void read(boolean force)
   throws CommunicationException

Reads the sales document. The back-end call happens if considered as necessary or if forced. The method also checks the BasketOrderConsistency and can trigger an update before the read happens.

Specified by:

read in interface SalesDocument

Parameters:

force - If true, then read even if not considered as necessary

Throws:

CommunicationException - in case back-end error

calculateTotalQuantity

java.math.BigDecimal calculateTotalQuantity()

Returns:

the total quantity of the products in basket

release

void release()
      throws CommunicationException

Releases cart object. Afterwards, cart is fully initialized

Throws:

CommunicationException