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

Class SalesDocumentBaseImpl<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

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<L,I,H>

Type Parameters:

L - The ItemList has to extend ItemListBase

I - The Item has to extend ItemBase objects

H - The Header has to extend HeaderBase

All Implemented Interfaces:

BackendAware, BusinessObject, MessageListHolder, SalesDocumentBase<L,I,H>, SimpleDocument<L,I,H>, Serializable, Cloneable, Iterable<I>

Direct Known Subclasses:

SalesDocumentImpl

public abstract class SalesDocumentBaseImpl<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>
extends SimpleDocumentImpl<L,I,H>
implements SalesDocumentBase<L,I,H>

Base class for all sales documents, e.g. Basket, Order etc.
The document consists in principle of a Header and a ItemList, which again contains Items. The type of all 3 objects can be passed to this class via generics to enable type safe access.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<BillTo>	billToList
protected boolean	changeHeaderOnly
protected boolean	persistentInBackend
protected List<ShipTo>	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
SalesDocumentBaseImpl()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the whole sales document including header and itemlist.
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.
List<BillTo>	getAlternativeBillTos()	Return the list of all available shipTos of this document.
List<ShipTo>	getAlternativeShipTos()	Return the list of all available shipTos of this document.
boolean	isChangeHeaderOnly()	Returns true if only the header should be changed
boolean	isPersistentInBackend()	Returns the information, if document is persistent in the back end
void	setPersistentInBackend(boolean isPersistent)	Set flag, if document is persistent in the back end

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

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

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

addExtensionData, addMessage, clearMessages, clearOwnMessages, clone, 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.SalesDocumentBase

isDeterminationRequired, setDeterminationRequired

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

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

Field Details

changeHeaderOnly

protected boolean changeHeaderOnly

shipToList

protected List<ShipTo> shipToList

billToList

protected List<BillTo> billToList

persistentInBackend

protected boolean persistentInBackend

Constructor Details

SalesDocumentBaseImpl

public SalesDocumentBaseImpl()

Method Details

clear

public void clear()

Description copied from interface: SimpleDocument

Clear the whole sales document including header and itemlist.

Specified by:

clear in interface SimpleDocument<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Overrides:

clear in class SimpleDocumentImpl<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

destroy

public 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.

Specified by:

destroy in interface BusinessObject

Overrides:

destroy in class BusinessObjectBase

isChangeHeaderOnly

public boolean isChangeHeaderOnly()

Returns true if only the header should be changed

Specified by:

isChangeHeaderOnly in interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Returns:

boolean true if only the header should be changed, false else

getAlternativeBillTos

public List<BillTo> getAlternativeBillTos()

Description copied from interface: SalesDocumentBase

Return the list of all available shipTos of this document. The billTos contain the address.

Specified by:

getAlternativeBillTos in interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Returns:

list of billTos.

getAlternativeShipTos

public List<ShipTo> getAlternativeShipTos()

Description copied from interface: SalesDocumentBase

Return the list of all available shipTos of this document. The shipTos contain the address.

Specified by:

getAlternativeShipTos in interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Returns:

list of shipTos.

isPersistentInBackend

public boolean isPersistentInBackend()

Description copied from interface: SalesDocumentBase

Returns the information, if document is persistent in the back end

Specified by:

isPersistentInBackend in interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Returns:

true, if document persists on DB in the back end

setPersistentInBackend

public void setPersistentInBackend(boolean isPersistent)

Description copied from interface: SalesDocumentBase

Set flag, if document is persistent in the back end

Specified by:

setPersistentInBackend in interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Parameters:

isPersistent - if true document is considered persistent