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

Class SimpleDocumentImpl<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

java.lang.Object

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

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

Type Parameters:

L - ItemList

I - Item

H - Header

All Implemented Interfaces:

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

Direct Known Subclasses:

SalesDocumentBaseImpl

public abstract class SimpleDocumentImpl<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>
extends BusinessObjectBase
implements SimpleDocument<L,I,H>

See Also:

• Serialized Form

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
SimpleDocumentImpl()

Method Summary

Modifier and Type	Method	Description
void	addItem(I item)	Adds a Item to the sales document.
void	clear()	Clear the whole sales document including header and itemlist.
void	clearHeader()	Convenience method to releases state of the header.
void	clearItems()	Convenience method to releases state of the ItemList.
void	clearMessages()	clear all messages and set state of the Business Object to valid.
String	getApplicationId()
Date	getChangeDate()
H	getHeader()	Returns the header associated with the sales document
I	getItem(TechKey techKey)	Returns the item of the document specified by the given technical key. Note - This is a convenience method operating on the getItem method of the internal ItemList.
L	getItemList()	Returns a list of the items currently stored for this sales document.
TechKey	getSoldToGuid()
Map<String,Object>	getTypedExtensionMap()	Type safe getter for the extension map
long	getVersion()
boolean	isDirty()	Get the dirty flag
Iterator<I>	iterator()	Returns an iterator for the items of the item list. This method guarantees to always return an iterator, even if the underlying item list object is null.
void	setApplicationId(String applicationId)
void	setChangeDate(Date changeDate)
void	setDirty(boolean isDirty)	Set the dirty flag
void	setHeader(H header)	Sets the header information.
void	setItemList(L itemList)	Sets the list of the items for this sales document.
void	setSoldToGuid(TechKey techKey)
void	setTechKey(TechKey techKey)	Sets the key for the document, as well as the document to dirty state.
void	setVersion(long version)
String	toString()	Returns a simplifies string representation of the object.

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

addExtensionData, addMessage, clearMessages, clearOwnMessages, clone, copyMessages, copyMessages, createUniqueHandle, destroy, 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, destroy, getExtensionData, getExtensionDataValues, getExtensionMap, getHandle, getOwnMessageList, getSubObjectIterator, getTechKey, hasHandle, hasMessages, hasOwnMessages, init, isValid, logMessage, removeExtensionData, removeExtensionDataValues, setExtensionMap, setHandle, setInvalid, setValid

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

addMessage, getMessageList

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

createItem

Constructor Details

SimpleDocumentImpl

public SimpleDocumentImpl()

Method Details

iterator

public Iterator<I> iterator()

Returns an iterator for the items of the item list.
This method guarantees to always return an iterator, even if the underlying item list object is null. In this case an iterator over an empty list is returned.

Specified by:

iterator in interface Iterable<L extends ItemListBase<I>>

Returns:

iterator to iterate over the items

addItem

public void addItem(I item)

Description copied from interface: SimpleDocument

Adds a Item to the sales document. This item must be uniquely identified by a technical key. A null reference passed to this function will be ignored, in this case nothing will happen.

Specified by:

addItem in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

item - Item to be added to the sales doc

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 SimpleItem,H extends SimpleHeader>

clearHeader

public void clearHeader()

Description copied from interface: SimpleDocument

Convenience method to releases state of the header. Same as getHeader().clear()

Specified by:

clearHeader in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

clearItems

public void clearItems()

Description copied from interface: SimpleDocument

Convenience method to releases state of the ItemList. Same as getItemList().clear()

Specified by:

clearItems in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

clearMessages

public void clearMessages()

clear all messages and set state of the Business Object to valid. By default all messages of sub objects will cleared also. Furthermore the document is set to dirty to force a back end call during next read

Specified by:

clearMessages in interface MessageListHolder

Overrides:

clearMessages in class BusinessObjectBase

getHeader

public H getHeader()

Description copied from interface: SimpleDocument

Returns the header associated with the sales document

Specified by:

getHeader in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

Header

getItem

public I getItem(TechKey techKey)

Description copied from interface: SimpleDocument

Returns the item of the document specified by the given technical key.

Note - This is a convenience method operating on the getItem method of the internal ItemList.

Specified by:

getItem in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

techKey - the technical key of the item that should be retrieved

Returns:

the item with the given techical key or null if no item for that key was found.

getItemList

public L getItemList()

Description copied from interface: SimpleDocument

Returns a list of the items currently stored for this sales document.

Specified by:

getItemList in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

list of items

isDirty

public boolean isDirty()

Description copied from interface: SimpleDocument

Get the dirty flag

Specified by:

isDirty in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

isDirty will the document be read from the backend when the a read method is called true/false

setDirty

public void setDirty(boolean isDirty)

Description copied from interface: SimpleDocument

Set the dirty flag

Specified by:

setDirty in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

isDirty - if set to true, the document will be read from the backend when a read method is called if set to false, the next call to a read method won't fill the object from the backend

setHeader

public void setHeader(H header)

Description copied from interface: SimpleDocument

Sets the header information. The header information is data common to all items of the basket.

Specified by:

setHeader in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

header - Header data to set

setItemList

public void setItemList(L itemList)

Description copied from interface: SimpleDocument

Sets the list of the items for this sales document.

Specified by:

setItemList in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

itemList - list of items to be stored

setTechKey

public void setTechKey(TechKey techKey)

Sets the key for the document, as well as the document to dirty state.

Specified by:

setTechKey in interface BusinessObject

Overrides:

setTechKey in class BusinessObjectBase

Parameters:

techKey - Key to be set

toString

public String toString()

Returns a simplifies string representation of the object. Useful for debugging/logging purpose, but not for display on the User Interface.

Overrides:

toString in class BusinessObjectBase

Returns:

object as string

getSoldToGuid

public TechKey getSoldToGuid()

Specified by:

getSoldToGuid in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

techKey GUID of the soldTo

setSoldToGuid

public void setSoldToGuid(TechKey techKey)

Specified by:

setSoldToGuid in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

techKey - GUID of the soldTo

setApplicationId

public void setApplicationId(String applicationId)

Specified by:

setApplicationId in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

applicationId - shop id

getApplicationId

public String getApplicationId()

Specified by:

getApplicationId in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

ID of application

getTypedExtensionMap

public Map<String,Object> getTypedExtensionMap()

Description copied from interface: SimpleDocument

Type safe getter for the extension map

Specified by:

getTypedExtensionMap in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

extension map attached to this document

getVersion

public long getVersion()

Specified by:

getVersion in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

version field to support jpa optimistic locking

setVersion

public void setVersion(long version)

Specified by:

setVersion in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

version - to support jpa optimistic locking

setChangeDate

public void setChangeDate(Date changeDate)

Specified by:

setChangeDate in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Parameters:

changeDate - date this document was last changed

getChangeDate

public Date getChangeDate()

Specified by:

getChangeDate in interface SimpleDocument<L extends ItemListBase<I>,I extends SimpleItem,H extends SimpleHeader>

Returns:

returns the date this document was last changed.