Interface Header
-
- All Superinterfaces:
BusinessObject,java.lang.Cloneable,HeaderBase,MessageListHolder,java.io.Serializable,SimpleHeader,StatusObject
- All Known Implementing Classes:
HeaderSalesDocument
public interface Header extends HeaderBase, StatusObject
This interface provides header data of a SalesDocument. The usual way to access it is calling method SalesDocument.getHeader().
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringNO_DELIVERY_PRIORITYConstant defining that no delivery priority is selectedstatic longNO_OF_ITEMS_UNKNOWNConstant defining that the number of items of a document is 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BusinessStatusgetBillingStatus()Gets the billing status of the Document.BillTogetBillTo()Gets the Bill-To-Party of the documentjava.lang.StringgetDeliveryStatus()Get DELIVERY status.java.lang.StringgetIncoTerms1()Get the incoterms1java.lang.StringgetIncoTerms1Desc()Get the incoterms1 descriptionjava.lang.StringgetIncoTerms2()Get the incoterms2.TechKeygetIpcDocumentId()Get the IPC document id.OverallStatusgetOverallStatus()get the aggregated overall statusjava.math.BigDecimalgetPaymentDeduction()Return the value that has to be deducted of the payment amount.java.lang.StringgetPaymentTerms()get the payment typesjava.lang.StringgetPaymentTermsDesc()Get the payment terms description.java.util.DategetPricingDate()Get the pricing datejava.lang.StringgetRecallDesc()Returns the recall descriptionjava.lang.StringgetRecallId()Returns the recall idjava.lang.StringgetShippingManualPriceCondition()Returns shipping manual price conditionBusinessStatusgetShippingStatus()get the business statusShipTogetShipTo()Get the ship to information as an backend layer interface.java.lang.StringgetTotalManualPriceCondition()Returns total manual price conditionbooleanisDeliveryStatusCompleted()Determines whether or not, the document's delivery status is COMPLETED.booleanisDeliveryStatusInProcess()Determines whether or not, the document's delivery status is INPROCESS.booleanisDeliveryStatusOpen()Determines whether or not, the document's delivery status is OPEN.booleanisDocumentTypeOrder()Determines whether or not, the document's type is ORDER.booleanisDocumentTypeQuotation()Determines whether or not, the document's type is QUOTATION.booleanisDocumentTypeRFQ()Determines whether or not, the document's type is RFQ.voidsetBillTo(BillTo billTo)Sets the Bill-To-Party into the the document.voidsetDeliveryStatusCompleted()Set DELIVERY status to completedvoidsetDeliveryStatusInProcess()Set DELIVERY status to in processvoidsetDeliveryStatusOpen()Set DELIVERY status to openvoidsetIncoTerms1(java.lang.String incoTerms1)Set the incoterms1.voidsetIncoTerms1Desc(java.lang.String incoTerms1Desc)Set the incoterms1 descriptionvoidsetIncoTerms2(java.lang.String incoTerms2)Set the incoterms2.voidsetIpcDocumentId(TechKey ipcDocumentId)Set the IPC document id.voidsetPaymentDeduction(java.math.BigDecimal value)Set the value that has to be deducted of the payment amount.voidsetPaymentTerms(java.lang.String paymentTerms)Set the payment terms.voidsetPaymentTermsDesc(java.lang.String paymentTermsDesc)Set the payment terms descriptionvoidsetPricingDate(java.util.Date pricingDate)Set the pricing date.voidsetRecallDesc(java.lang.String recallDesc)Sets the recall descriptionvoidsetRecallId(java.lang.String recallId)Sets the recall idvoidsetShippingManualPriceCondition(java.lang.String priceType)Sets the shipping manual price conditionvoidsetShipTo(ShipTo shipToData)Sets the default ship to for the header.voidsetTotalManualPriceCondition(java.lang.String priceType)Sets the total manual price condition-
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, clone, 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
clear, getDescription, getText, getTypedExtensionMap, isDirty, setDescription, setDirty, setText
-
Methods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.StatusObject
setBillingStatus, setOverallStatus, setShippingStatus
-
-
-
-
Field Detail
-
NO_OF_ITEMS_UNKNOWN
static final long NO_OF_ITEMS_UNKNOWN
Constant defining that the number of items of a document is unknown. Thus it must be determined by the size of the itemList.- See Also:
- Constant Field Values
-
NO_DELIVERY_PRIORITY
static final java.lang.String NO_DELIVERY_PRIORITY
Constant defining that no delivery priority is selected- See Also:
- Constant Field Values
-
-
Method Detail
-
getBillingStatus
BusinessStatus getBillingStatus()
Gets the billing status of the Document.- Returns:
- Billing status
-
getBillTo
BillTo getBillTo()
Gets the Bill-To-Party of the document- Returns:
- Bill-To-Party
-
getDeliveryStatus
java.lang.String getDeliveryStatus()
Get DELIVERY status. Might be different from OVERALL status.- Returns:
- one of the possible status values represented by the constants defined in this class with the names
DOCUMENT_COMPLETION_*.
-
getIncoTerms1
java.lang.String getIncoTerms1()
Get the incoterms1- Returns:
- String the incoterms1
-
getIncoTerms1Desc
java.lang.String getIncoTerms1Desc()
Get the incoterms1 description- Returns:
- String the incoterms1 description
-
getIncoTerms2
java.lang.String getIncoTerms2()
Get the incoterms2.- Returns:
- String the incoterms2.
-
getIpcDocumentId
TechKey getIpcDocumentId()
Get the IPC document id.- Returns:
- the IPC document id
-
getOverallStatus
OverallStatus getOverallStatus()
get the aggregated overall status- Returns:
- overall status
-
getPaymentTerms
java.lang.String getPaymentTerms()
get the payment types- Returns:
- payment types
-
getPaymentTermsDesc
java.lang.String getPaymentTermsDesc()
Get the payment terms description.- Returns:
- String the payment terms description.
-
getPricingDate
java.util.Date getPricingDate()
Get the pricing date- Returns:
- the pricing date
-
getRecallDesc
java.lang.String getRecallDesc()
Returns the recall description- Returns:
- the recall description
-
getRecallId
java.lang.String getRecallId()
Returns the recall id- Returns:
- the recall id
-
getShippingManualPriceCondition
java.lang.String getShippingManualPriceCondition()
Returns shipping manual price condition- Returns:
- shipping manual price condition
-
getShippingStatus
BusinessStatus getShippingStatus()
get the business status- Returns:
- business status
-
getShipTo
ShipTo getShipTo()
Get the ship to information as an backend layer interface.- Returns:
- the ship to information
-
getTotalManualPriceCondition
java.lang.String getTotalManualPriceCondition()
Returns total manual price condition- Returns:
- total manual price condition
-
isDeliveryStatusCompleted
boolean isDeliveryStatusCompleted()
Determines whether or not, the document's delivery status is COMPLETED.- Returns:
trueif the object is in status COMPLETED, otherwisefalse.
-
isDeliveryStatusInProcess
boolean isDeliveryStatusInProcess()
Determines whether or not, the document's delivery status is INPROCESS.- Returns:
trueif the object is in status INPROCESS, otherwisefalse.
-
isDeliveryStatusOpen
boolean isDeliveryStatusOpen()
Determines whether or not, the document's delivery status is OPEN.- Returns:
trueif the object is in status OPEN, otherwisefalse.
-
isDocumentTypeOrder
boolean isDocumentTypeOrder()
Determines whether or not, the document's type is ORDER.- Returns:
trueif the type is ORDER, otherwisefalse.
-
setBillTo
void setBillTo(BillTo billTo)
Sets the Bill-To-Party into the the document.- Parameters:
billTo- bill-to party
-
setDeliveryStatusCompleted
void setDeliveryStatusCompleted()
Set DELIVERY status to completed
-
setDeliveryStatusInProcess
void setDeliveryStatusInProcess()
Set DELIVERY status to in process
-
setDeliveryStatusOpen
void setDeliveryStatusOpen()
Set DELIVERY status to open
-
setIncoTerms1
void setIncoTerms1(java.lang.String incoTerms1)
Set the incoterms1.- Parameters:
incoTerms1- the incoterms1 to be set.
-
setIncoTerms1Desc
void setIncoTerms1Desc(java.lang.String incoTerms1Desc)
Set the incoterms1 description- Parameters:
incoTerms1Desc- the incoterms1 description to be set.
-
setIncoTerms2
void setIncoTerms2(java.lang.String incoTerms2)
Set the incoterms2.- Parameters:
incoTerms2- the incoterms2 to be set.
-
setIpcDocumentId
void setIpcDocumentId(TechKey ipcDocumentId)
Set the IPC document id.- Parameters:
ipcDocumentId- the IPC document id to be set
-
setPaymentTerms
void setPaymentTerms(java.lang.String paymentTerms)
Set the payment terms.- Parameters:
paymentTerms- the payment terms to be set.
-
setPaymentTermsDesc
void setPaymentTermsDesc(java.lang.String paymentTermsDesc)
Set the payment terms description- Parameters:
paymentTermsDesc- the payment terms description to be set.
-
setPricingDate
void setPricingDate(java.util.Date pricingDate)
Set the pricing date.- Parameters:
pricingDate- the pricing date
-
setRecallDesc
void setRecallDesc(java.lang.String recallDesc)
Sets the recall description- Parameters:
recallDesc- the recall description
-
setRecallId
void setRecallId(java.lang.String recallId)
Sets the recall id- Parameters:
recallId- the recall id
-
setShippingManualPriceCondition
void setShippingManualPriceCondition(java.lang.String priceType)
Sets the shipping manual price condition- Parameters:
priceType- new shipping manual price condition
-
setShipTo
void setShipTo(ShipTo shipToData)
Sets the default ship to for the header. This ship to is used, if no special information is set at the item level.- Parameters:
shipToData- The ship to, to be set
-
setTotalManualPriceCondition
void setTotalManualPriceCondition(java.lang.String priceType)
Sets the total manual price condition- Parameters:
priceType- manual price conidtion
-
getPaymentDeduction
java.math.BigDecimal getPaymentDeduction()
Return the value that has to be deducted of the payment amount.- Returns:
- BigDecimal
-
setPaymentDeduction
void setPaymentDeduction(java.math.BigDecimal value)
Set the value that has to be deducted of the payment amount.- Parameters:
value- amount to be deducted
-
isDocumentTypeQuotation
boolean isDocumentTypeQuotation()
Determines whether or not, the document's type is QUOTATION.- Returns:
trueif the type is QUOTATION, otherwisefalse.
-
isDocumentTypeRFQ
boolean isDocumentTypeRFQ()
Determines whether or not, the document's type is RFQ.- Returns:
trueif the type is RFQ, otherwisefalse.
-
-