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

Interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>

Type Parameters:

L - type of the item List

I - type of the items of the item list

H - type of the header

All Superinterfaces:

BusinessObject, java.lang.Iterable<I>, MessageListHolder, java.io.Serializable, SimpleDocument<L,I,H>

All Known Subinterfaces:

Basket, Order, SalesDocument

All Known Implementing Classes:

BasketImpl, OrderHistoryImpl, OrderImpl, SalesDocumentBaseImpl, SalesDocumentImpl

public interface SalesDocumentBase<L extends ItemListBase<I>,I extends ItemBase,H extends HeaderBase>
extends SimpleDocument<L,I,H>

Base Interface 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.

• The Header has to extend HeaderBase
• The ItemList has to extend ItemListBase
• The Item has to extend ItemBase objects

Field Summary

Fields

Modifier and Type	Field	Description
static int	NO_OF_ITEMS_UNKNOWN	Constant defining that the number of items of a document is unknown.

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

INVALID, VALID

Method Summary

Modifier and Type	Method	Description
java.util.List<BillTo>	getAlternativeBillTos()	Return the list of all available shipTos of this document.
java.util.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	isDeterminationRequired()	Determines if manual Product-, Campaign-, ...
boolean	isPersistentInBackend()	Returns the information, if document is persistent in the back end
void	setDeterminationRequired(boolean isDeterminationRequired)	Sets the isDeterminationRequired flag
void	setPersistentInBackend(boolean isPersistent)	Set flag, if document is persistent in the back end

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

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

Field Detail

NO_OF_ITEMS_UNKNOWN

static final int NO_OF_ITEMS_UNKNOWN

Constant defining that the number of items of a document is unknown. Thus it must be determined by the size if the itemList.

See Also:

Constant Field Values

Method Detail

getAlternativeShipTos

java.util.List<ShipTo> getAlternativeShipTos()

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

Returns:

list of shipTos.

getAlternativeBillTos

java.util.List<BillTo> getAlternativeBillTos()

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

Returns:

list of billTos.

isChangeHeaderOnly

boolean isChangeHeaderOnly()

Returns true if only the header should be changed

Returns:

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

isDeterminationRequired

boolean isDeterminationRequired()

Determines if manual Product-, Campaign-, ... Determination is necessary for at least one top level item.

Returns:

boolean true if there is at least on item that needs manual determination for products, camapigns, etc.

setDeterminationRequired

void setDeterminationRequired(boolean isDeterminationRequired)

Sets the isDeterminationRequired flag

Parameters:

isDeterminationRequired - true if there are items that need manual determination either for camapigns, substitution products or something similar

isPersistentInBackend

boolean isPersistentInBackend()

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

Returns:

true, if document persists on DB in the back end

setPersistentInBackend

void setPersistentInBackend(boolean isPersistent)

Set flag, if document is persistent in the back end

Parameters:

isPersistent - if true document is considered persistent