Interface Item
-
- All Superinterfaces:
BusinessObject,java.lang.Cloneable,java.lang.Comparable<SimpleItem>,ItemBase,MessageListHolder,java.io.Serializable,SimpleItem,StatusObject
- All Known Subinterfaces:
CPQItem
- All Known Implementing Classes:
CPQItemSalesDoc,ItemSalesDoc
public interface Item extends ItemBase, StatusObject
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
Fields Modifier and Type Field Description static java.lang.StringDELIVERY_DELAYEDReturn value for back-end Delivery meaning product delivery is delayedstatic java.lang.StringDELIVERY_IN_STOCKReturn value for back-end Delivery meaning product can be delivered completely.static java.lang.StringDELIVERY_OUT_OF_STOCKReturn value for back-end Delivery meaning product can not be deliveredstatic java.lang.StringDELIVERY_PARTLYReturn 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_VARIANT
-
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 voidapplyAlternativeProduct(TechKey productGUID, java.lang.String productID)Apply alternative product, e.g.AlternativeProductListcreateAlternativProductList()Creates a new AlternativProductListData.AlternativeProductListgetAlternativProductList()Returns the alternativProductList.BillingStatusgetBillingStatus()returns the billing status of the itemOverallStatusgetOverallStatus()Returns the overall statusjava.lang.StringgetParentHandle()Returns the parentHandle, that is the handle of the parent, if the position is a sub positionjava.lang.StringgetPaymentTerms()Get the payment terms.java.util.DategetPricingDate()Get the date which is used to calculate prices in IPCProcessingStatusgetProcessingStatus()Get the processing status of the sales document item.java.math.BigDecimalgetQuantityToPay()This getter is dependent on the quantity and the free quantity of this product.java.lang.StringgetRejectionCode()Gets rejection/cancellation reason for the order.ShippingStatusgetShippingStatus()Get The shipping statusShipTogetShipTo()Returns the shipTo associated with this itemjava.lang.StringgetSubstitutionReasonId()Returns the substitutionReasonId.java.lang.StringgetSystemProductId()Returns the systemProductId.booleanisChangeAllowed()booleanisCopiedFromOtherItem()This method returns a flag, that indicates if the item is copied from another item, e.g.booleanisFreeGood()Determines whether the item is a free good by checking the item usage.booleanisFromCatalog()Indicates whether the item is originated from catalog.booleanisMergeSupported(Item toMerge)Checks whether this item can be merged with the given item.booleanisSubItem()Indicates 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(java.lang.String parentHandle)Sets the parentHandle, that is the handle of the parent, if the position is a sub positionvoidsetPaymentTerms(java.lang.String paymentTerms)Set the payment terms.voidsetPricingDate(java.util.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(java.lang.String rejection)Sets rejection/cancellation reason for the order.voidsetShipTo(ShipTo shipTo)Sets the shiptTo for this item.voidsetSubstitutionReasonId(java.lang.String substitutionReasonId)Sets the substitutionReasonId.voidsetSystemProductId(java.lang.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, setValid
-
Methods 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, setVariant
-
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.item.businessobject.interf.SimpleItem
getDescription, getLastQuantity, getNumberInt, getParentId, getProductGuid, getProductId, getQuantity, getTypedExtensionMap, getUnit, isProductChanged, setDescription, setNumberInt, setParentId, setProductChanged, setProductGuid, setProductId, setQuantity, setUnit
-
Methods inherited from interface de.hybris.platform.sap.sapordermgmtbol.transaction.businessobject.interf.StatusObject
setBillingStatus, setOverallStatus, setShippingStatus
-
-
-
-
Field Detail
-
DELIVERY_IN_STOCK
static final java.lang.String DELIVERY_IN_STOCK
Return value for back-end Delivery meaning product can be delivered completely.- See Also:
- Constant Field Values
-
DELIVERY_PARTLY
static final java.lang.String DELIVERY_PARTLY
Return value for back-end Delivery meaning product can be delivered partly.- See Also:
- Constant Field Values
-
DELIVERY_DELAYED
static final java.lang.String DELIVERY_DELAYED
Return value for back-end Delivery meaning product delivery is delayed- See Also:
- Constant Field Values
-
DELIVERY_OUT_OF_STOCK
static final java.lang.String DELIVERY_OUT_OF_STOCK
Return value for back-end Delivery meaning product can not be delivered- See Also:
- Constant Field Values
-
-
Method Detail
-
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
java.lang.String getParentHandle()
Returns the parentHandle, that is the handle of the parent, if the position is a sub position- Returns:
- String the parentHandle
-
getPaymentTerms
java.lang.String getPaymentTerms()
Get the payment terms.- Returns:
- paymentTerms the payment terms set.
-
getPricingDate
java.util.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
java.lang.String getSubstitutionReasonId()
Returns the substitutionReasonId.- Returns:
- String
-
getSystemProductId
java.lang.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
boolean isMergeSupported(Item toMerge)
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
void setAlternativProductList(AlternativeProductList alternativProductList)
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
void setParentHandle(java.lang.String parentHandle)
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
void setPaymentTerms(java.lang.String paymentTerms)
Set the payment terms.- Parameters:
paymentTerms- the payment terms to be set.
-
setPricingDate
void setPricingDate(java.util.Date pricingDate)
set the date which is used to calculate prices in IPC- Parameters:
pricingDate- date which should be used for pricing
-
setShipTo
void setShipTo(ShipTo shipTo)
Sets the shiptTo for this item.- Parameters:
shipTo- shipTo to which the item will be shipped
-
setSubstitutionReasonId
void setSubstitutionReasonId(java.lang.String substitutionReasonId)
Sets the substitutionReasonId.- Parameters:
substitutionReasonId- The substitutionReasonId to set
-
setSystemProductId
void setSystemProductId(java.lang.String systemProductId)
Sets the systemProductId.- Parameters:
systemProductId- The systemProductId to set
-
setRejectionCode
void setRejectionCode(java.lang.String rejection)
Sets rejection/cancellation reason for the order.- Parameters:
rejection- cancellation reason (key)
-
getRejectionCode
java.lang.String getRejectionCode()
Gets rejection/cancellation reason for the order.- Returns:
- cancellation reason (key)
-
getQuantityToPay
java.math.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
void setProcessingStatus(ProcessingStatus processingStatus)
Get the processing status of the sales document item. The processing status equates GBSTA field in ERP back end- Parameters:
processingStatus- ProcessingStatus
-
applyAlternativeProduct
void applyAlternativeProduct(TechKey productGUID, java.lang.String productID) throws CommunicationException
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
-
-