com.ibm.commerce.order.facade.datatypes
Interface OrderItemType
-
- All Known Implementing Classes:
- OrderItemTypeImpl
public interface OrderItemType
A representation of the model object 'Item Type'. Type definition of an order item.The following features are supported:
Order Item Identifier
Catalog Entry Identifier
Item Attributes
Order Item Component
Quantity
Configuration ID
Order Item Configuration
Contract Identifier
Offer ID
Adjustment Requirement
Order Item Amount
Usable Shipping Address
Usable Shipping Mode
Order Item Shipping Info
Order Item Status
Order Item Fulfillment Info
Fulfillment Center
Correlation Group
Order Item Description
Comments
Create Date
Last Update Date
Usable Shipping Charge Policy
Gift Item Info
User Data
Order Item Extend Attribute
- See Also:
OrderPackage.getOrderItemType()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description java.util.List
getAdjustmentRequirement()
Returns the value of the 'Adjustment Requirement' containment reference list.CatalogEntryIdentifierType
getCatalogEntryIdentifier()
Returns the value of the 'Catalog Entry Identifier' containment reference.java.lang.String
getComments()
Returns the value of the 'Comments' attribute.java.lang.String
getConfigurationID()
Returns the value of the 'Configuration ID' attribute.ContractIdentifierType
getContractIdentifier()
Returns the value of the 'Contract Identifier' containment reference.java.lang.String
getCorrelationGroup()
Returns the value of the 'Correlation Group' attribute.java.lang.Object
getCreateDate()
Returns the value of the 'Create Date' attribute.FulfillmentCenterType
getFulfillmentCenter()
Returns the value of the 'Fulfillment Center' containment reference.com.ibm.commerce.order.facade.datatypes.GiftItemInfoType
getGiftItemInfo()
Returns the value of the 'Gift Item Info' containment reference.java.util.Map
getItemAttributes()
Returns the value of the 'Item Attributes' map.java.lang.Object
getLastUpdateDate()
Returns the value of the 'Last Update Date' attribute.java.lang.String
getOfferID()
Returns the value of the 'Offer ID' attribute.OrderItemChargesType
getOrderItemAmount()
Returns the value of the 'Order Item Amount' containment reference.java.util.List
getOrderItemComponent()
Returns the value of the 'Order Item Component' containment reference list.java.lang.String
getOrderItemConfiguration()
Returns the value of the 'Order Item Configuration' attribute.java.lang.String
getOrderItemDescription()
Returns the value of the 'Order Item Description' attribute.java.util.List
getOrderItemExtendAttribute()
Returns the value of the 'Order Item Extend Attribute' containment reference list.OrderItemFulfillmentInfoType
getOrderItemFulfillmentInfo()
Returns the value of the 'Order Item Fulfillment Info' containment reference.OrderItemIdentifierType
getOrderItemIdentifier()
Returns the value of the 'Order Item Identifier' containment reference.OrderItemShippingInfoType
getOrderItemShippingInfo()
Returns the value of the 'Order Item Shipping Info' containment reference.OrderItemStatusType
getOrderItemStatus()
Returns the value of the 'Order Item Status' containment reference.QuantityType
getQuantity()
Returns the value of the 'Quantity' containment reference.java.util.List
getUsableShippingAddress()
Returns the value of the 'Usable Shipping Address' containment reference list.java.util.List
getUsableShippingChargePolicy()
Returns the value of the 'Usable Shipping Charge Policy' containment reference list.java.util.List
getUsableShippingMode()
Returns the value of the 'Usable Shipping Mode' containment reference list.UserDataType
getUserData()
Returns the value of the 'User Data' containment reference.void
setCatalogEntryIdentifier(CatalogEntryIdentifierType value)
Sets the value of the 'Catalog Entry Identifier
' containment reference.void
setComments(java.lang.String value)
Sets the value of the 'Comments
' attribute.void
setConfigurationID(java.lang.String value)
Sets the value of the 'Configuration ID
' attribute.void
setContractIdentifier(ContractIdentifierType value)
Sets the value of the 'Contract Identifier
' containment reference.void
setCorrelationGroup(java.lang.String value)
Sets the value of the 'Correlation Group
' attribute.void
setCreateDate(java.lang.Object value)
Sets the value of the 'Create Date
' attribute.void
setFulfillmentCenter(FulfillmentCenterType value)
Sets the value of the 'Fulfillment Center
' containment reference.void
setGiftItemInfo(com.ibm.commerce.order.facade.datatypes.GiftItemInfoType value)
Sets the value of the 'Gift Item Info
' containment reference.void
setLastUpdateDate(java.lang.Object value)
Sets the value of the 'Last Update Date
' attribute.void
setOfferID(java.lang.String value)
Sets the value of the 'Offer ID
' attribute.void
setOrderItemAmount(OrderItemChargesType value)
Sets the value of the 'Order Item Amount
' containment reference.void
setOrderItemConfiguration(java.lang.String value)
Sets the value of the 'Order Item Configuration
' attribute.void
setOrderItemDescription(java.lang.String value)
Sets the value of the 'Order Item Description
' attribute.void
setOrderItemFulfillmentInfo(OrderItemFulfillmentInfoType value)
Sets the value of the 'Order Item Fulfillment Info
' containment reference.void
setOrderItemIdentifier(OrderItemIdentifierType value)
Sets the value of the 'Order Item Identifier
' containment reference.void
setOrderItemShippingInfo(OrderItemShippingInfoType value)
Sets the value of the 'Order Item Shipping Info
' containment reference.void
setOrderItemStatus(OrderItemStatusType value)
Sets the value of the 'Order Item Status
' containment reference.void
setQuantity(QuantityType value)
Sets the value of the 'Quantity
' containment reference.void
setUserData(UserDataType value)
Sets the value of the 'User Data
' containment reference.
-
-
-
Method Detail
-
getOrderItemIdentifier
OrderItemIdentifierType getOrderItemIdentifier()
Returns the value of the 'Order Item Identifier' containment reference. The order item identifier.- Returns:
- the value of the 'Order Item Identifier' containment reference.
- See Also:
setOrderItemIdentifier(OrderItemIdentifierType)
,OrderPackage.getOrderItemType_OrderItemIdentifier()
-
setOrderItemIdentifier
void setOrderItemIdentifier(OrderItemIdentifierType value)
Sets the value of the 'Order Item Identifier
' containment reference.- Parameters:
value
- the new value of the 'Order Item Identifier' containment reference.- See Also:
getOrderItemIdentifier()
-
getCatalogEntryIdentifier
CatalogEntryIdentifierType getCatalogEntryIdentifier()
Returns the value of the 'Catalog Entry Identifier' containment reference. The catalog entry identifier.- Returns:
- the value of the 'Catalog Entry Identifier' containment reference.
- See Also:
setCatalogEntryIdentifier(CatalogEntryIdentifierType)
,OrderPackage.getOrderItemType_CatalogEntryIdentifier()
-
setCatalogEntryIdentifier
void setCatalogEntryIdentifier(CatalogEntryIdentifierType value)
Sets the value of the 'Catalog Entry Identifier
' containment reference.- Parameters:
value
- the new value of the 'Catalog Entry Identifier' containment reference.- See Also:
getCatalogEntryIdentifier()
-
getItemAttributes
java.util.Map getItemAttributes()
Returns the value of the 'Item Attributes' map. The key is of typeString
, and the value is of typeString
, Product specific attributes for this item.- Returns:
- the value of the 'Item Attributes' map.
- See Also:
OrderPackage.getOrderItemType_ItemAttributes()
-
getOrderItemComponent
java.util.List getOrderItemComponent()
Returns the value of the 'Order Item Component' containment reference list. The list contents are of typeOrderItemComponentType
. Components of the product if it is a kit.- Returns:
- the value of the 'Order Item Component' containment reference list.
- See Also:
OrderPackage.getOrderItemType_OrderItemComponent()
-
getQuantity
QuantityType getQuantity()
Returns the value of the 'Quantity' containment reference. The quantity ordered.- Returns:
- the value of the 'Quantity' containment reference.
- See Also:
setQuantity(QuantityType)
,OrderPackage.getOrderItemType_Quantity()
-
setQuantity
void setQuantity(QuantityType value)
Sets the value of the 'Quantity
' containment reference.- Parameters:
value
- the new value of the 'Quantity' containment reference.- See Also:
getQuantity()
-
getConfigurationID
java.lang.String getConfigurationID()
Returns the value of the 'Configuration ID' attribute. The configuration ID.- Returns:
- the value of the 'Configuration ID' attribute.
- See Also:
setConfigurationID(String)
,OrderPackage.getOrderItemType_ConfigurationID()
-
setConfigurationID
void setConfigurationID(java.lang.String value)
Sets the value of the 'Configuration ID
' attribute.- Parameters:
value
- the new value of the 'Configuration ID' attribute.- See Also:
getConfigurationID()
-
getOrderItemConfiguration
java.lang.String getOrderItemConfiguration()
Returns the value of the 'Order Item Configuration' attribute. Configuration details of a dynamic kit.- Returns:
- the value of the 'Order Item Configuration' attribute.
- See Also:
setOrderItemConfiguration(String)
,OrderPackage.getOrderItemType_OrderItemConfiguration()
-
setOrderItemConfiguration
void setOrderItemConfiguration(java.lang.String value)
Sets the value of the 'Order Item Configuration
' attribute.- Parameters:
value
- the new value of the 'Order Item Configuration' attribute.- See Also:
getOrderItemConfiguration()
-
getContractIdentifier
ContractIdentifierType getContractIdentifier()
Returns the value of the 'Contract Identifier' containment reference. The contract Identifier.- Returns:
- the value of the 'Contract Identifier' containment reference.
- See Also:
setContractIdentifier(ContractIdentifierType)
,OrderPackage.getOrderItemType_ContractIdentifier()
-
setContractIdentifier
void setContractIdentifier(ContractIdentifierType value)
Sets the value of the 'Contract Identifier
' containment reference.- Parameters:
value
- the new value of the 'Contract Identifier' containment reference.- See Also:
getContractIdentifier()
-
getOfferID
java.lang.String getOfferID()
Returns the value of the 'Offer ID' attribute. The offer ID.- Returns:
- the value of the 'Offer ID' attribute.
- See Also:
setOfferID(String)
,OrderPackage.getOrderItemType_OfferID()
-
setOfferID
void setOfferID(java.lang.String value)
Sets the value of the 'Offer ID
' attribute.- Parameters:
value
- the new value of the 'Offer ID' attribute.- See Also:
getOfferID()
-
getAdjustmentRequirement
java.util.List getAdjustmentRequirement()
Returns the value of the 'Adjustment Requirement' containment reference list. The list contents are of typeAdjustmentRequirementType
. Order item level adjustment requirements.- Returns:
- the value of the 'Adjustment Requirement' containment reference list.
- See Also:
OrderPackage.getOrderItemType_AdjustmentRequirement()
-
getOrderItemAmount
OrderItemChargesType getOrderItemAmount()
Returns the value of the 'Order Item Amount' containment reference. Amounts of the order item.- Returns:
- the value of the 'Order Item Amount' containment reference.
- See Also:
setOrderItemAmount(OrderItemChargesType)
,OrderPackage.getOrderItemType_OrderItemAmount()
-
setOrderItemAmount
void setOrderItemAmount(OrderItemChargesType value)
Sets the value of the 'Order Item Amount
' containment reference.- Parameters:
value
- the new value of the 'Order Item Amount' containment reference.- See Also:
getOrderItemAmount()
-
getUsableShippingAddress
java.util.List getUsableShippingAddress()
Returns the value of the 'Usable Shipping Address' containment reference list. The list contents are of typeContactInfoIdentifierType
. Usable Shipping addresses for the order item.- Returns:
- the value of the 'Usable Shipping Address' containment reference list.
- See Also:
OrderPackage.getOrderItemType_UsableShippingAddress()
-
getUsableShippingMode
java.util.List getUsableShippingMode()
Returns the value of the 'Usable Shipping Mode' containment reference list. The list contents are of typeShippingModeType
. Usable Shipping modes for the order item.- Returns:
- the value of the 'Usable Shipping Mode' containment reference list.
- See Also:
OrderPackage.getOrderItemType_UsableShippingMode()
-
getOrderItemShippingInfo
OrderItemShippingInfoType getOrderItemShippingInfo()
Returns the value of the 'Order Item Shipping Info' containment reference. Shipping information of the order item.- Returns:
- the value of the 'Order Item Shipping Info' containment reference.
- See Also:
setOrderItemShippingInfo(OrderItemShippingInfoType)
,OrderPackage.getOrderItemType_OrderItemShippingInfo()
-
setOrderItemShippingInfo
void setOrderItemShippingInfo(OrderItemShippingInfoType value)
Sets the value of the 'Order Item Shipping Info
' containment reference.- Parameters:
value
- the new value of the 'Order Item Shipping Info' containment reference.- See Also:
getOrderItemShippingInfo()
-
getOrderItemStatus
OrderItemStatusType getOrderItemStatus()
Returns the value of the 'Order Item Status' containment reference. Status of the order item.- Returns:
- the value of the 'Order Item Status' containment reference.
- See Also:
setOrderItemStatus(OrderItemStatusType)
,OrderPackage.getOrderItemType_OrderItemStatus()
-
setOrderItemStatus
void setOrderItemStatus(OrderItemStatusType value)
Sets the value of the 'Order Item Status
' containment reference.- Parameters:
value
- the new value of the 'Order Item Status' containment reference.- See Also:
getOrderItemStatus()
-
getOrderItemFulfillmentInfo
OrderItemFulfillmentInfoType getOrderItemFulfillmentInfo()
Returns the value of the 'Order Item Fulfillment Info' containment reference. Fulfillment information of the order item.- Returns:
- the value of the 'Order Item Fulfillment Info' containment reference.
- See Also:
setOrderItemFulfillmentInfo(OrderItemFulfillmentInfoType)
,OrderPackage.getOrderItemType_OrderItemFulfillmentInfo()
-
setOrderItemFulfillmentInfo
void setOrderItemFulfillmentInfo(OrderItemFulfillmentInfoType value)
Sets the value of the 'Order Item Fulfillment Info
' containment reference.- Parameters:
value
- the new value of the 'Order Item Fulfillment Info' containment reference.- See Also:
getOrderItemFulfillmentInfo()
-
getFulfillmentCenter
FulfillmentCenterType getFulfillmentCenter()
Returns the value of the 'Fulfillment Center' containment reference. The fulfillment center.- Returns:
- the value of the 'Fulfillment Center' containment reference.
- See Also:
setFulfillmentCenter(FulfillmentCenterType)
,OrderPackage.getOrderItemType_FulfillmentCenter()
-
setFulfillmentCenter
void setFulfillmentCenter(FulfillmentCenterType value)
Sets the value of the 'Fulfillment Center
' containment reference.- Parameters:
value
- the new value of the 'Fulfillment Center' containment reference.- See Also:
getFulfillmentCenter()
-
getCorrelationGroup
java.lang.String getCorrelationGroup()
Returns the value of the 'Correlation Group' attribute. CorrelationGroup of the order item.- Returns:
- the value of the 'Correlation Group' attribute.
- See Also:
setCorrelationGroup(String)
,OrderPackage.getOrderItemType_CorrelationGroup()
-
setCorrelationGroup
void setCorrelationGroup(java.lang.String value)
Sets the value of the 'Correlation Group
' attribute.- Parameters:
value
- the new value of the 'Correlation Group' attribute.- See Also:
getCorrelationGroup()
-
getOrderItemDescription
java.lang.String getOrderItemDescription()
Returns the value of the 'Order Item Description' attribute. Description of the order item.- Returns:
- the value of the 'Order Item Description' attribute.
- See Also:
setOrderItemDescription(String)
,OrderPackage.getOrderItemType_OrderItemDescription()
-
setOrderItemDescription
void setOrderItemDescription(java.lang.String value)
Sets the value of the 'Order Item Description
' attribute.- Parameters:
value
- the new value of the 'Order Item Description' attribute.- See Also:
getOrderItemDescription()
-
getComments
java.lang.String getComments()
Returns the value of the 'Comments' attribute. Comments made by the customer.- Returns:
- the value of the 'Comments' attribute.
- See Also:
setComments(String)
,OrderPackage.getOrderItemType_Comments()
-
setComments
void setComments(java.lang.String value)
Sets the value of the 'Comments
' attribute.- Parameters:
value
- the new value of the 'Comments' attribute.- See Also:
getComments()
-
getCreateDate
java.lang.Object getCreateDate()
Returns the value of the 'Create Date' attribute. Time the order item is created.- Returns:
- the value of the 'Create Date' attribute.
- See Also:
setCreateDate(Object)
,OrderPackage.getOrderItemType_CreateDate()
-
setCreateDate
void setCreateDate(java.lang.Object value)
Sets the value of the 'Create Date
' attribute.- Parameters:
value
- the new value of the 'Create Date' attribute.- See Also:
getCreateDate()
-
getLastUpdateDate
java.lang.Object getLastUpdateDate()
Returns the value of the 'Last Update Date' attribute. Time the order item is last updated.- Returns:
- the value of the 'Last Update Date' attribute.
- See Also:
setLastUpdateDate(Object)
,OrderPackage.getOrderItemType_LastUpdateDate()
-
setLastUpdateDate
void setLastUpdateDate(java.lang.Object value)
Sets the value of the 'Last Update Date
' attribute.- Parameters:
value
- the new value of the 'Last Update Date' attribute.- See Also:
getLastUpdateDate()
-
getUsableShippingChargePolicy
java.util.List getUsableShippingChargePolicy()
Returns the value of the 'Usable Shipping Charge Policy' containment reference list. The list contents are of typePolicyIdentifierType
. This element is used to display all usable shipping charge methods for an order item. Each order item has multiple usable shipping charge methods. Shopper can view and select one of them for the current order item. Possible values can be "Charge by seller" and "Charge by carrier".- Returns:
- the value of the 'Usable Shipping Charge Policy' containment reference list.
- See Also:
OrderPackage.getOrderItemType_UsableShippingChargePolicy()
-
getGiftItemInfo
com.ibm.commerce.order.facade.datatypes.GiftItemInfoType getGiftItemInfo()
Returns the value of the 'Gift Item Info' containment reference. The gift list info for the order item.- Returns:
- the value of the 'Gift Item Info' containment reference.
- See Also:
setGiftItemInfo(GiftItemInfoType)
,OrderPackage.getOrderItemType_GiftItemInfo()
-
setGiftItemInfo
void setGiftItemInfo(com.ibm.commerce.order.facade.datatypes.GiftItemInfoType value)
Sets the value of the 'Gift Item Info
' containment reference.- Parameters:
value
- the new value of the 'Gift Item Info' containment reference.- See Also:
getGiftItemInfo()
-
getUserData
UserDataType getUserData()
Returns the value of the 'User Data' containment reference. The user data area.- Returns:
- the value of the 'User Data' containment reference.
- See Also:
setUserData(UserDataType)
,OrderPackage.getOrderItemType_UserData()
-
setUserData
void setUserData(UserDataType value)
Sets the value of the 'User Data
' containment reference.- Parameters:
value
- the new value of the 'User Data' containment reference.- See Also:
getUserData()
-
getOrderItemExtendAttribute
java.util.List getOrderItemExtendAttribute()
Returns the value of the 'Order Item Extend Attribute' containment reference list. The list contents are of typeExtendAttributeType
. The order item extended attributes- Returns:
- the value of the 'Order Item Extend Attribute' containment reference list.
- See Also:
OrderPackage.getOrderItemType_OrderItemExtendAttribute()
-
-