Interface Item
- All Superinterfaces:
BusinessObject,Cloneable,Comparable<SimpleItem>,ItemBase,MessageListHolder,Serializable,SimpleItem,StatusObject
- All Known Subinterfaces:
CPQItem
- All Known Implementing Classes:
CPQItemSalesDoc,ItemSalesDoc
Represents the backend's view of the items of a shopping basket.
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.item.businessobject.interf.ItemBase
ItemBase.ItemUsage -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringReturn value for back-end Delivery meaning product delivery is delayedstatic final StringReturn value for back-end Delivery meaning product can be delivered completely.static final StringReturn value for back-end Delivery meaning product can not be deliveredstatic final StringReturn value for back-end Delivery meaning product can be delivered partly.Fields inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.item.businessobject.interf.ItemBase
ITEM_CONFIGTYPE_VARIANTFields inherited from interface de.hybris.platform.sap.core.common.message.MessageListHolder
INVALID, VALID -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyAlternativeProduct(TechKey productGUID, String productID) Apply alternative product, e.g.Creates a new AlternativProductListData.Returns the alternativProductList.returns the billing status of the itemReturns the overall statusReturns the parentHandle, that is the handle of the parent, if the position is a sub positionGet the payment terms.Get the date which is used to calculate prices in IPCGet the processing status of the sales document item.This getter is dependent on the quantity and the free quantity of this product.Gets rejection/cancellation reason for the order.Get The shipping statusReturns the shipTo associated with this itemReturns the substitutionReasonId.Returns the systemProductId.booleanbooleanThis method returns a flag, that indicates if the item is copied from another item, e.g.booleanDetermines whether the item is a free good by checking the item usage.booleanIndicates whether the item is originated from catalog.booleanisMergeSupported(Item toMerge) Checks whether this item can be merged with the given item.booleanIndicates whether the item is a subitem (has a parent) or notvoidsetAlternativProductList(AlternativeProductList alternativProductList) Sets the alternativProductListData.voidsetCopiedFromOtherItem(boolean isCopiedFromOtherItem) This method sets a flag, that indicates if the item is copied from another item, e.g.voidsetFromCatalog(boolean fromCatalog) Indicate whether the item is originated from catalog.voidsetParentHandle(String parentHandle) Sets the parentHandle, that is the handle of the parent, if the position is a sub positionvoidsetPaymentTerms(String paymentTerms) Set the payment terms.voidsetPricingDate(Date pricingDate) set the date which is used to calculate prices in IPCvoidsetProcessingStatus(ProcessingStatus processingStatus) Get the processing status of the sales document item.voidsetRejectionCode(String rejection) Sets rejection/cancellation reason for the order.voidSets the shiptTo for this item.voidsetSubstitutionReasonId(String substitutionReasonId) Sets the substitutionReasonId.voidsetSystemProductId(String systemProductId) Sets the systemProductId.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, setValidMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.item.businessobject.interf.ItemBase
addPredecessor, addSuccessor, clone, createConnectedDocumentItemData, createScheduleLine, createText, getConfigType, getConfirmedDeliveryDate, getConfirmedQuantity, getCreatedAt, getCurrency, getDeliveredQuantity, getDeliveredQuantityUnit, getDeliveryPriority, getFreeQuantity, getFreightValue, getGrossValue, getGrossValueWOFreight, getItemCategory, getItemUsage, getItmTypeUsage, getNetPrice, getNetPriceUnit, getNetPriceWOFreight, getNetQuantPriceUnit, getNetValue, getNetValueWOFreight, getOldQuantity, getPartnerListData, getPossibleUnits, getPredecessorList, getQuantityToDeliver, getReqDeliveryDate, getScheduleLines, getSuccessorList, getTaxValue, getText, getTotalDiscount, isCancelable, isConfigurable, isConfigurationDirty, isDeletable, isErroneous, isProductEmpty, isProductExists, isStatistical, isVariant, setBusinessObjectType, setCancelable, setConfigType, setConfigurable, setConfigurableDirty, setConfirmedDeliveryDate, setConfirmedQuantity, setCreatedAt, setCurrency, setDeletable, setDeliverdQuantity, setDeliverdQuantityUnit, setDeliveryPriority, setErroneous, setFreeQuantity, setFreightValue, setGrossValue, setGrossValueWOFreight, setItemCategory, setItemUsage, setItmTypeUsage, setLatestDeliveryDate, setNetPrice, setNetPriceUnit, setNetPriceWOFreight, setNetQuantPriceUnit, setNetValue, setNetValueWOFreight, setOldQuantity, setPartnerListData, setPossibleUnits, setPriceRelevant, setProductExists, setQuantityToDeliver, setReqDeliveryDate, setScheduleLines, setStatistical, setTaxValue, setText, setTotalDiscount, setVariantMethods inherited from interface de.hybris.platform.sap.core.common.message.MessageListHolder
addMessage, clearMessages, getMessageListMethods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.item.businessobject.interf.SimpleItem
getDescription, getLastQuantity, getNumberInt, getParentId, getProductGuid, getProductId, getQuantity, getTypedExtensionMap, getUnit, isProductChanged, setDescription, setNumberInt, setParentId, setProductChanged, setProductGuid, setProductId, setQuantity, setUnitMethods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.StatusObject
setBillingStatus, setOverallStatus, setShippingStatus
-
Field Details
-
DELIVERY_IN_STOCK
Return value for back-end Delivery meaning product can be delivered completely.- See Also:
-
DELIVERY_PARTLY
Return value for back-end Delivery meaning product can be delivered partly.- See Also:
-
DELIVERY_DELAYED
Return value for back-end Delivery meaning product delivery is delayed- See Also:
-
DELIVERY_OUT_OF_STOCK
Return value for back-end Delivery meaning product can not be delivered- See Also:
-
-
Method Details
-
createAlternativProductList
AlternativeProductList createAlternativProductList()Creates a new AlternativProductListData.- Returns:
- AlternativProductListData
-
getAlternativProductList
AlternativeProductList getAlternativProductList()Returns the alternativProductList.- Returns:
- AlternativProductListData
-
getBillingStatus
BillingStatus getBillingStatus()returns the billing status of the item- Returns:
- the actual billing statuts of the item
-
getOverallStatus
OverallStatus getOverallStatus()Returns the overall status- Returns:
- the overall item status
-
getParentHandle
String getParentHandle()Returns the parentHandle, that is the handle of the parent, if the position is a sub position- Returns:
- String the parentHandle
-
getPaymentTerms
String getPaymentTerms()Get the payment terms.- Returns:
- paymentTerms the payment terms set.
-
getPricingDate
Date getPricingDate()Get the date which is used to calculate prices in IPC- Returns:
- date relevant for pricing
-
getShippingStatus
ShippingStatus getShippingStatus()Get The shipping status- Returns:
- the shipping status of the item
-
getShipTo
ShipTo getShipTo()Returns the shipTo associated with this item- Returns:
- the shipTo to which this item will be shipped to
-
getSubstitutionReasonId
String getSubstitutionReasonId()Returns the substitutionReasonId.- Returns:
- String
-
getSystemProductId
String getSystemProductId()Returns the systemProductId.- Returns:
- String
-
isChangeAllowed
boolean isChangeAllowed()- Returns:
- true if the item can be changed
-
isCopiedFromOtherItem
boolean isCopiedFromOtherItem()This method returns a flag, that indicates if the item is copied from another item, e.g. when an order is created from an order template If so, this flag might be used, to suppress things like campaign determination, etc. for the copied item.- Returns:
- true if this item is copied from another item false else
-
isFreeGood
boolean isFreeGood()Determines whether the item is a free good by checking the item usage.- Returns:
true, only if this item is a FreeGood
-
isFromCatalog
boolean isFromCatalog()Indicates whether the item is originated from catalog.- Returns:
trueif the item is from catalog; otherwisefalse.
-
isMergeSupported
Checks whether this item can be merged with the given item.- Parameters:
toMerge- the item this item should be merged with- Returns:
true, only if this item can be merged with the given item
-
setAlternativProductList
Sets the alternativProductListData.- Parameters:
alternativProductList- The alternativProductList to set
-
setFromCatalog
void setFromCatalog(boolean fromCatalog) Indicate whether the item is originated from catalog.- Parameters:
fromCatalog- should be set totrueif the item originated from catalog
-
setParentHandle
Sets the parentHandle, that is the handle of the parent, if the position is a sub position- Parameters:
parentHandle- the new value for the parentHandle
-
setPaymentTerms
Set the payment terms.- Parameters:
paymentTerms- the payment terms to be set.
-
setPricingDate
set the date which is used to calculate prices in IPC- Parameters:
pricingDate- date which should be used for pricing
-
setShipTo
Sets the shiptTo for this item.- Parameters:
shipTo- shipTo to which the item will be shipped
-
setSubstitutionReasonId
Sets the substitutionReasonId.- Parameters:
substitutionReasonId- The substitutionReasonId to set
-
setSystemProductId
Sets the systemProductId.- Parameters:
systemProductId- The systemProductId to set
-
setRejectionCode
Sets rejection/cancellation reason for the order.- Parameters:
rejection- cancellation reason (key)
-
getRejectionCode
String getRejectionCode()Gets rejection/cancellation reason for the order.- Returns:
- cancellation reason (key)
-
getQuantityToPay
BigDecimal getQuantityToPay()This getter is dependent on the quantity and the free quantity of this product.- Returns:
- the quantity that must be paid
-
setCopiedFromOtherItem
void setCopiedFromOtherItem(boolean isCopiedFromOtherItem) This method sets a flag, that indicates if the item is copied from another item, e.g. when an order is created from an order template If so, this flag might be used, to suppress things like campaign determination, etc. for the copied item.- Parameters:
isCopiedFromOtherItem- true when item is copied
-
getProcessingStatus
ProcessingStatus getProcessingStatus()Get the processing status of the sales document item. The processing status equates GBSTA field in ERP back end
Used for the definition of possible cancellation- Returns:
- BusinessStatus
-
setProcessingStatus
Get the processing status of the sales document item. The processing status equates GBSTA field in ERP back end- Parameters:
processingStatus- ProcessingStatus
-
applyAlternativeProduct
Apply alternative product, e.g. product to be substituted with .- Parameters:
productGUID- GUID of the applied productproductID- ID of the applied product- Throws:
CommunicationException- in case of an back-end error
-
isSubItem
boolean isSubItem()Indicates whether the item is a subitem (has a parent) or not- Returns:
- true if subitem
-