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

Interface SimpleHeader

All Superinterfaces:

BusinessObject, java.lang.Cloneable, MessageListHolder, java.io.Serializable

All Known Subinterfaces:

Header, HeaderBase

All Known Implementing Classes:

HeaderBaseImpl, HeaderSalesDocument, SimpleHeaderImpl

public interface SimpleHeader
extends BusinessObject, java.lang.Cloneable

This base class encapsulates the most common features of a header (e.g. a description).

Field Summary

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

INVALID, VALID

Method Summary

Modifier and Type	Method	Description
void	clear()	Drops the state of the object.
java.lang.String	getDescription()	Get description added on the header level.
Text	getText()	Get text on the header level of the document.
java.util.Map<java.lang.String,java.lang.Object>	getTypedExtensionMap()	Type safe getter for the extension map
boolean	isDirty()	get the dirty flag
void	setDescription(java.lang.String description)	Sets the description on the header level.
void	setDirty(boolean isDirty)	Set the dirty flag
void	setText(Text text)	Set the text on the header level of the document.

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 de.hybris.platform.sap.core.common.message.MessageListHolder

addMessage, clearMessages, getMessageList

Method Detail

clear

void clear()

Drops the state of the object. All reference fields, except partnerList, are set to null, all primitive types are set to the default values they would have after the creation of a new instance. Use this method to reset the state to the state a newly created object would have. The advantage is, that the overhead caused by the normal object creation is omitted.

isDirty

boolean isDirty()

get the dirty flag

Returns:

isDirty must the header be read from the backend true/false

setDirty

void setDirty(boolean isDirty)

Set the dirty flag

Parameters:

isDirty - must the header be read from the backend true/false

getDescription

java.lang.String getDescription()

Get description added on the header level.

Returns:

description

getText

Text getText()

Get text on the header level of the document.

Returns:

the text

setDescription

void setDescription(java.lang.String description)

Sets the description on the header level.

Parameters:

description - the description

setText

void setText(Text text)

Set the text on the header level of the document.

Parameters:

text - the text to be set

getTypedExtensionMap

java.util.Map<java.lang.String,java.lang.Object> getTypedExtensionMap()

Type safe getter for the extension map

Returns:

extension map attached to this header