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

Class HeaderSalesDocument

java.lang.Object

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

de.hybris.platform.sap.sapordermgmtbol.transaction.header.businessobject.impl.SimpleHeaderImpl

de.hybris.platform.sap.sapordermgmtbol.transaction.header.businessobject.impl.HeaderBaseImpl

de.hybris.platform.sap.sapordermgmtbol.transaction.header.businessobject.impl.HeaderSalesDocument

All Implemented Interfaces:

BackendAware, BusinessObject, MessageListHolder, StatusObject, Header, HeaderBase, SimpleHeader, java.io.Serializable, java.lang.Cloneable

public class HeaderSalesDocument
extends HeaderBaseImpl
implements Header

Common Header Information for all objects of the bo layer that are considered to be sales documents.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Date	pricingDate	Pricing date
protected java.lang.String	recallDesc	Service recall description
protected java.lang.String	recallId	Service recall ID
protected UserStatusList	userStatusList	List of user status

Fields inherited from class de.hybris.platform.sap.sapordermgmtbol.transaction.header.businessobject.impl.HeaderBaseImpl

changeable, changedAt, createdAt, currency, deliveryPriority, disChannel, division, documentType, freightValue, grossValue, grossValueWOFreight, netValue, netValueWOFreight, partnerList, postingDate, predecessorList, processType, processTypeDesc, purchaseOrderExt, reqDeliveryDate, salesDocNumber, salesDocumentsOrigin, salesOffice, salesOrg, shipCond, successorList, taxValue, totalDiscount, totalValue, validFrom, validTo

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.sapordermgmtbol.transaction.header.businessobject.interf.Header

NO_DELIVERY_PRIORITY, NO_OF_ITEMS_UNKNOWN

Fields inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.header.businessobject.interf.HeaderBase

DOCUMENT_COMPLETION_STATUS_COMPLETED, DOCUMENT_COMPLETION_STATUS_INPROCESS, DOCUMENT_COMPLETION_STATUS_OPEN

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

INVALID, VALID

Constructor Summary

Constructors

Constructor	Description
HeaderSalesDocument()

Method Summary

Modifier and Type	Method	Description
void	clear()	Drops the state of the object.
java.lang.Object	clone()	Instead of a shallow-copy this returns a deep-copy of this HeaderBaseImpl instance.
BusinessStatus	getBillingStatus()	Gets the billing status of the Document.
BillTo	getBillTo()	Gets the Bill-To-Party of the document
java.lang.String	getDeliveryStatus()	Get DELIVERY status.
java.lang.String	getIncoTerms1()	Get the incoterms1
java.lang.String	getIncoTerms1Desc()	Get the incoterms1 description
java.lang.String	getIncoTerms2()	Get the incoterms2.
TechKey	getIpcDocumentId()	Get the IPC document id.
OverallStatus	getOverallStatus()	get the aggregated overall status
java.math.BigDecimal	getPaymentDeduction()	Return the value that has to be deducted of the payment amount.
java.lang.String	getPaymentTerms()	get the payment types
java.lang.String	getPaymentTermsDesc()	Get the payment terms description.
java.util.Date	getPricingDate()	Get the pricing date
java.lang.String	getRecallDesc()	Returns the recall description
java.lang.String	getRecallId()	Returns the recall id
java.lang.String	getShippingManualPriceCondition()	Returns shipping manual price condition
BusinessStatus	getShippingStatus()	get the business status
ShipTo	getShipTo()	Get the ship to information as an backend layer interface.
java.lang.String	getTotalManualPriceCondition()	Returns total manual price condition
boolean	isDeliveryStatusCompleted()	Determines whether or not, the document's delivery status is COMPLETED.
boolean	isDeliveryStatusInProcess()	Determines whether or not, the document's delivery status is INPROCESS.
boolean	isDeliveryStatusOpen()	Determines whether or not, the document's delivery status is OPEN.
boolean	isDocumentTypeOrder()	Determines whether or not, the document's type is ORDER.
boolean	isDocumentTypeQuotation()	Determines whether or not, the document's type is QUOTATION.
boolean	isDocumentTypeRFQ()	Determines whether or not, the document's type is RFQ.
void	setBillingStatus(BillingStatus billStatus)	Set the billing status for this object.
void	setBillTo(BillTo billTo)	Sets the Bill-To-Party into the the document.
void	setDeliveryStatusCompleted()	Set DELIVERY status to completed
void	setDeliveryStatusInProcess()	Set DELIVERY status to in process
void	setDeliveryStatusOpen()	Set DELIVERY status to open
void	setIncoTerms1(java.lang.String incoTerms1)	Set the incoterms1.
void	setIncoTerms1Desc(java.lang.String incoTerms1Desc)	Set the incoterms1 description
void	setIncoTerms2(java.lang.String incoTerms2)	Set the incoterms2.
void	setIpcDocumentId(TechKey ipcDocumentId)	Set the IPC document id.
void	setOverallStatus(OverallStatus procStatus)	Set the overall status for this object.
void	setPaymentDeduction(java.math.BigDecimal value)	Set the value that has to be deducted of the payment amount.
void	setPaymentTerms(java.lang.String paymentTerms)	Set the payment terms.
void	setPaymentTermsDesc(java.lang.String paymentTermsDesc)	Set the payment terms description
void	setPricingDate(java.util.Date pricingDate)	Set the pricing date.
void	setRecallDesc(java.lang.String recallDesc)	Sets the recall description
void	setRecallId(java.lang.String recallId)	Sets the recall id
void	setShippingManualPriceCondition(java.lang.String priceType)	Sets the shipping manual price condition
void	setShippingStatus(ShippingStatus shipStatus)	Set the shipping status for this object.
void	setShipTo(ShipTo shipTo)	Sets the default ship to for the header.
void	setTotalManualPriceCondition(java.lang.String priceType)	Sets the total manual price condition
void	setUserStatusList(UserStatusList userStatusList)	Sets list of user statuses
java.lang.String	toString()	Returns a simplifies string representation of the object.

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

addPredecessor, addSuccessor, consolidateDate, createConnectedDocument, createText, getChangedAt, getCreatedAt, getCurrency, getDeliveryPriority, getDisChannel, getDivision, getDocumentType, getFreightValue, getGrossValue, getGrossValueWOFreight, getNetValue, getNetValueWOFreight, getPartnerId, getPartnerKey, getPartnerList, getPostingDate, getPredecessorList, getProcessType, getProcessTypeDesc, getPurchaseOrderExt, getReqDeliveryDate, getSalesDocNumber, getSalesDocumentsOrigin, getSalesOffice, getSalesOrg, getShipCond, getSuccessorList, getTaxValue, getTotalDiscount, getValidFrom, getValidTo, isChangeable, setChangeable, setChangedAt, setCreatedAt, setCurrency, setDeliveryPriority, setDisChannel, setDivision, setDocumentType, setFreightValue, setGrossValue, setGrossValueWOFreight, setNetValue, setNetValueWOFreight, setPartnerList, setPostingDate, setProcessType, setProcessTypeDesc, setPurchaseOrderExt, setReqDeliveryDate, setSalesDocNumber, setSalesDocumentsOrigin, setSalesOffice, setSalesOrg, setShipCond, setTaxValue, setTechKey, setTotalDiscount, setValidFrom, setValidTo

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

getDescription, getText, getTypedExtensionMap, isDirty, setDescription, setDirty, setText

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

addExtensionData, addMessage, clearMessages, clearMessages, clearOwnMessages, 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, setTechKey, setValid

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

addPredecessor, addSuccessor, createConnectedDocument, createText, getChangedAt, getCreatedAt, getCurrency, getDeliveryPriority, getDisChannel, getDivision, getDocumentType, getFreightValue, getGrossValue, getGrossValueWOFreight, getNetValue, getNetValueWOFreight, getPartnerId, getPartnerKey, getPartnerList, getPostingDate, getPredecessorList, getProcessType, getProcessTypeDesc, getPurchaseOrderExt, getReqDeliveryDate, getSalesDocNumber, getSalesDocumentsOrigin, getSalesOffice, getSalesOrg, getShipCond, getSuccessorList, getTaxValue, getTotalDiscount, getValidFrom, getValidTo, isChangeable, setChangeable, setChangedAt, setCreatedAt, setCurrency, setDeliveryPriority, setDisChannel, setDivision, setDocumentType, setFreightValue, setGrossValue, setGrossValueWOFreight, setNetValue, setNetValueWOFreight, setPartnerList, setPostingDate, setProcessType, setProcessTypeDesc, setPurchaseOrderExt, setReqDeliveryDate, setSalesDocNumber, setSalesDocumentsOrigin, setSalesOffice, setSalesOrg, setShipCond, setTaxValue, setTotalDiscount, setValidFrom, setValidTo

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.header.businessobject.interf.SimpleHeader

getDescription, getText, getTypedExtensionMap, isDirty, setDescription, setDirty, setText

Field Detail

recallId

protected java.lang.String recallId

Service recall ID

recallDesc

protected java.lang.String recallDesc

Service recall description

userStatusList

protected UserStatusList userStatusList

List of user status

pricingDate

protected java.util.Date pricingDate

Pricing date

Constructor Detail

HeaderSalesDocument

public HeaderSalesDocument()

Method Detail

clear

public void clear()

Description copied from class: HeaderBaseImpl

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.

Specified by:

clear in interface SimpleHeader

Overrides:

clear in class HeaderBaseImpl

clone

public java.lang.Object clone()

Description copied from class: HeaderBaseImpl

Instead of a shallow-copy this returns a deep-copy of this HeaderBaseImpl instance.

Specified by:

clone in interface HeaderBase

Overrides:

clone in class HeaderBaseImpl

Returns:

a deep-copy of this HeaderBase

getBillingStatus

public BusinessStatus getBillingStatus()

Description copied from interface: Header

Gets the billing status of the Document.

Specified by:

getBillingStatus in interface Header

Returns:

Billing status

getBillTo

public BillTo getBillTo()

Description copied from interface: Header

Gets the Bill-To-Party of the document

Specified by:

getBillTo in interface Header

Returns:

Bill-To-Party

getDeliveryStatus

public java.lang.String getDeliveryStatus()

Description copied from interface: Header

Get DELIVERY status. Might be different from OVERALL status.

Specified by:

getDeliveryStatus in interface Header

Returns:

one of the possible status values represented by the constants defined in this class with the names DOCUMENT_COMPLETION_*.

getIncoTerms1

public java.lang.String getIncoTerms1()

Description copied from interface: Header

Get the incoterms1

Specified by:

getIncoTerms1 in interface Header

Returns:

String the incoterms1

getIncoTerms1Desc

public java.lang.String getIncoTerms1Desc()

Description copied from interface: Header

Get the incoterms1 description

Specified by:

getIncoTerms1Desc in interface Header

Returns:

String the incoterms1 description

getIncoTerms2

public java.lang.String getIncoTerms2()

Description copied from interface: Header

Get the incoterms2.

Specified by:

getIncoTerms2 in interface Header

Returns:

String the incoterms2.

getIpcDocumentId

public TechKey getIpcDocumentId()

Description copied from interface: Header

Get the IPC document id.

Specified by:

getIpcDocumentId in interface Header

Returns:

the IPC document id

getOverallStatus

public OverallStatus getOverallStatus()

Description copied from interface: Header

get the aggregated overall status

Specified by:

getOverallStatus in interface Header

Returns:

overall status

getPaymentTerms

public java.lang.String getPaymentTerms()

Description copied from interface: Header

get the payment types

Specified by:

getPaymentTerms in interface Header

Returns:

payment types

getPaymentTermsDesc

public java.lang.String getPaymentTermsDesc()

Description copied from interface: Header

Get the payment terms description.

Specified by:

getPaymentTermsDesc in interface Header

Returns:

String the payment terms description.

getPricingDate

public java.util.Date getPricingDate()

Description copied from interface: Header

Get the pricing date

Specified by:

getPricingDate in interface Header

Returns:

the pricing date

getRecallDesc

public java.lang.String getRecallDesc()

Description copied from interface: Header

Returns the recall description

Specified by:

getRecallDesc in interface Header

Returns:

the recall description

getRecallId

public java.lang.String getRecallId()

Description copied from interface: Header

Returns the recall id

Specified by:

getRecallId in interface Header

Returns:

the recall id

getShippingManualPriceCondition

public java.lang.String getShippingManualPriceCondition()

Description copied from interface: Header

Returns shipping manual price condition

Specified by:

getShippingManualPriceCondition in interface Header

Returns:

shipping manual price condition

getShippingStatus

public BusinessStatus getShippingStatus()

Description copied from interface: Header

get the business status

Specified by:

getShippingStatus in interface Header

Returns:

business status

getShipTo

public ShipTo getShipTo()

Description copied from interface: Header

Get the ship to information as an backend layer interface.

Specified by:

getShipTo in interface Header

Returns:

the ship to information

getTotalManualPriceCondition

public java.lang.String getTotalManualPriceCondition()

Description copied from interface: Header

Returns total manual price condition

Specified by:

getTotalManualPriceCondition in interface Header

Returns:

total manual price condition

isDeliveryStatusCompleted

public boolean isDeliveryStatusCompleted()

Description copied from interface: Header

Determines whether or not, the document's delivery status is COMPLETED.

Specified by:

isDeliveryStatusCompleted in interface Header

Returns:

true if the object is in status COMPLETED, otherwise false.

isDeliveryStatusInProcess

public boolean isDeliveryStatusInProcess()

Description copied from interface: Header

Determines whether or not, the document's delivery status is INPROCESS.

Specified by:

isDeliveryStatusInProcess in interface Header

Returns:

true if the object is in status INPROCESS, otherwise false.

isDeliveryStatusOpen

public boolean isDeliveryStatusOpen()

Description copied from interface: Header

Determines whether or not, the document's delivery status is OPEN.

Specified by:

isDeliveryStatusOpen in interface Header

Returns:

true if the object is in status OPEN, otherwise false.

isDocumentTypeOrder

public boolean isDocumentTypeOrder()

Description copied from interface: Header

Determines whether or not, the document's type is ORDER.

Specified by:

isDocumentTypeOrder in interface Header

Returns:

true if the type is ORDER, otherwise false.

isDocumentTypeQuotation

public boolean isDocumentTypeQuotation()

Description copied from interface: Header

Determines whether or not, the document's type is QUOTATION.

Specified by:

isDocumentTypeQuotation in interface Header

Returns:

true if the type is QUOTATION, otherwise false.

isDocumentTypeRFQ

public boolean isDocumentTypeRFQ()

Description copied from interface: Header

Determines whether or not, the document's type is RFQ.

Specified by:

isDocumentTypeRFQ in interface Header

Returns:

true if the type is RFQ, otherwise false.

setBillingStatus

public void setBillingStatus(BillingStatus billStatus)

Description copied from interface: StatusObject

Set the billing status for this object.

Specified by:

setBillingStatus in interface StatusObject

Parameters:

billStatus - Billing Status

setBillTo

public void setBillTo(BillTo billTo)

Description copied from interface: Header

Sets the Bill-To-Party into the the document.

Specified by:

setBillTo in interface Header

Parameters:

billTo - bill-to party

setDeliveryStatusCompleted

public void setDeliveryStatusCompleted()

Description copied from interface: Header

Set DELIVERY status to completed

Specified by:

setDeliveryStatusCompleted in interface Header

setDeliveryStatusInProcess

public void setDeliveryStatusInProcess()

Description copied from interface: Header

Set DELIVERY status to in process

Specified by:

setDeliveryStatusInProcess in interface Header

setDeliveryStatusOpen

public void setDeliveryStatusOpen()

Description copied from interface: Header

Set DELIVERY status to open

Specified by:

setDeliveryStatusOpen in interface Header

setIncoTerms1

public void setIncoTerms1(java.lang.String incoTerms1)

Description copied from interface: Header

Set the incoterms1.

Specified by:

setIncoTerms1 in interface Header

Parameters:

incoTerms1 - the incoterms1 to be set.

setIncoTerms1Desc

public void setIncoTerms1Desc(java.lang.String incoTerms1Desc)

Description copied from interface: Header

Set the incoterms1 description

Specified by:

setIncoTerms1Desc in interface Header

Parameters:

incoTerms1Desc - the incoterms1 description to be set.

setIncoTerms2

public void setIncoTerms2(java.lang.String incoTerms2)

Description copied from interface: Header

Set the incoterms2.

Specified by:

setIncoTerms2 in interface Header

Parameters:

incoTerms2 - the incoterms2 to be set.

setIpcDocumentId

public void setIpcDocumentId(TechKey ipcDocumentId)

Description copied from interface: Header

Set the IPC document id.

Specified by:

setIpcDocumentId in interface Header

Parameters:

ipcDocumentId - the IPC document id to be set

setOverallStatus

public void setOverallStatus(OverallStatus procStatus)

Description copied from interface: StatusObject

Set the overall status for this object.

Specified by:

setOverallStatus in interface StatusObject

Parameters:

procStatus - Overall Status

setPaymentTerms

public void setPaymentTerms(java.lang.String paymentTerms)

Description copied from interface: Header

Set the payment terms.

Specified by:

setPaymentTerms in interface Header

Parameters:

paymentTerms - the payment terms to be set.

setPaymentTermsDesc

public void setPaymentTermsDesc(java.lang.String paymentTermsDesc)

Description copied from interface: Header

Set the payment terms description

Specified by:

setPaymentTermsDesc in interface Header

Parameters:

paymentTermsDesc - the payment terms description to be set.

setPricingDate

public void setPricingDate(java.util.Date pricingDate)

Description copied from interface: Header

Set the pricing date.

Specified by:

setPricingDate in interface Header

Parameters:

pricingDate - the pricing date

setRecallDesc

public void setRecallDesc(java.lang.String recallDesc)

Description copied from interface: Header

Sets the recall description

Specified by:

setRecallDesc in interface Header

Parameters:

recallDesc - the recall description

setRecallId

public void setRecallId(java.lang.String recallId)

Description copied from interface: Header

Sets the recall id

Specified by:

setRecallId in interface Header

Parameters:

recallId - the recall id

setShippingManualPriceCondition

public void setShippingManualPriceCondition(java.lang.String priceType)

Description copied from interface: Header

Sets the shipping manual price condition

Specified by:

setShippingManualPriceCondition in interface Header

Parameters:

priceType - new shipping manual price condition

setShippingStatus

public void setShippingStatus(ShippingStatus shipStatus)

Description copied from interface: StatusObject

Set the shipping status for this object.

Specified by:

setShippingStatus in interface StatusObject

Parameters:

shipStatus - Shipping Status

setShipTo

public void setShipTo(ShipTo shipTo)

Description copied from interface: Header

Sets the default ship to for the header. This ship to is used, if no special information is set at the item level.

Specified by:

setShipTo in interface Header

Parameters:

shipTo - The ship to, to be set

setTotalManualPriceCondition

public void setTotalManualPriceCondition(java.lang.String priceType)

Description copied from interface: Header

Sets the total manual price condition

Specified by:

setTotalManualPriceCondition in interface Header

Parameters:

priceType - manual price conidtion

setUserStatusList

public void setUserStatusList(UserStatusList userStatusList)

Sets list of user statuses

Parameters:

userStatusList -

toString

public java.lang.String toString()

Description copied from class: HeaderBaseImpl

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 HeaderBaseImpl

Returns:

object as string

getPaymentDeduction

public java.math.BigDecimal getPaymentDeduction()

Description copied from interface: Header

Return the value that has to be deducted of the payment amount.

Specified by:

getPaymentDeduction in interface Header

Returns:

BigDecimal

setPaymentDeduction

public void setPaymentDeduction(java.math.BigDecimal value)

Description copied from interface: Header

Set the value that has to be deducted of the payment amount.

Specified by:

setPaymentDeduction in interface Header

Parameters:

value - amount to be deducted