com.imc.iss.groovy.order

Class OrderItem

java.lang.Object

com.imc.iss.groovy.order.OrderItem

public class OrderItem
extends Object

OrderItem class

Since:

2102

Constructor Summary

Constructors

Constructor and Description
OrderItem()

Method Summary

Modifier and Type	Method and Description
BigDecimal	getDiscount() Retrieves the discount of this line item
Object	getOrderItemDataAttributeValue(String attributeURI) To get the value of a orderItem data attribute by attribute URI.
String	getOrderItemRelationAttributeErpId(String attributeURI) To get the ERPID of a orderItem relation attribute by attribute URI.
String	getOrderItemRelationAttributeObjectId(String attributeURI) To get the object Id of a orderItem relation attribute by attribute URI.
String	getOrderItemRelationAttributeObjectName(String attributeURI) To get the object name of a orderItem relation attribute by attribute URI.
String	getOrderItemRelationAttributeURI(String attributeURI) To get the URI of a orderItem relation attribute by attribute URI.
String	getOrderItemURI() To get the URI of a orderItem
PriceItemData	getPriceItemByTypeName(String name) To get the price Item data by name.
PriceItemData	getPriceItemByTypeUri(String uri) To get the price Item data by price item type URI.
PriceItemData	getPriceItemByUri(String uri) To get the price Item data by price item URI.
List<PriceItemData>	getPriceItemsByTypeName(String name) To get all the price Item data by the name of the price item type.
List<PriceItemData>	getPriceItemsByTypeUri(String uri) To get all the price Item data by the URI of the price item type .
List<PriceItemData>	getPriceItemsJustified(String justificationURI) To get all justified price Item data.
String	getProductErpId() Retrieves the ERP ID of this line item
String	getProductObjectName() Retrieves the product name of this line item
String	getProductTypeErpId() Retrieves the product type ERPID of this line item
String	getProductTypeURI() Retrieves the product type URI of this line item
String	getProductURI() Retrieves the product URI of this line item
BigDecimal	getQuantity() Retrieves the quantity of this line item
String	getSalesItemURI() Retrieves the URI of linked salesitem of this order item
OrderItem	setDataAttribute(String attributeURI, Object value) To set a value for the order item data attribute.
OrderItem	setRelationAttribute(String attributeURI, String valueURI) To set a value for the order item relation attribute.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrderItem

public OrderItem()

Method Detail

getDiscount

public BigDecimal getDiscount()
                       throws IMCException

Retrieves the discount of this line item

Returns:

The discount of this line item

Throws:

IMCException - the platform exception

getOrderItemDataAttributeValue

public Object getOrderItemDataAttributeValue(String attributeURI)
                                      throws IMCException

To get the value of a orderItem data attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the orderItem data attribute.

Returns:

the value of the orderItem data attribute as Object.

Throws:

IMCException - the platform exception

getOrderItemRelationAttributeErpId

public String getOrderItemRelationAttributeErpId(String attributeURI)
                                          throws IMCException

To get the ERPID of a orderItem relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the orderItem relation attribute.

Returns:

the ERPId of the orderItem relation attribute as String.

Throws:

IMCException - the platform exception

getOrderItemRelationAttributeObjectId

public String getOrderItemRelationAttributeObjectId(String attributeURI)
                                             throws IMCException

To get the object Id of a orderItem relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the orderItem relation attribute.

Returns:

the objectId of the orderItem relation attribute as String.

Throws:

IMCException - the platform exception

getOrderItemRelationAttributeObjectName

public String getOrderItemRelationAttributeObjectName(String attributeURI)
                                               throws IMCException

To get the object name of a orderItem relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the orderItem relation attribute.

Returns:

the object name of the orderItem relation attribute as String.

Throws:

IMCException - the platform exception

getOrderItemRelationAttributeURI

public String getOrderItemRelationAttributeURI(String attributeURI)
                                        throws IMCException

To get the URI of a orderItem relation attribute by attribute URI.

Parameters:

attributeURI - as String. The URI of the orderItem relation attribute.

Returns:

the object URI of the orderItem relation attribute as String.

Throws:

IMCException - the platform exception

getOrderItemURI

public String getOrderItemURI()

To get the URI of a orderItem

Returns:

the URI of the orderItem as String.

getPriceItemByTypeName

public PriceItemData getPriceItemByTypeName(String name)
                                     throws IMCException

To get the price Item data by name. PriceItemData

Parameters:

name - as String the name of the price item.

Returns:

PriceItemData.

Throws:

IMCException - the platform exception

getPriceItemByTypeUri

public PriceItemData getPriceItemByTypeUri(String uri)
                                    throws IMCException

To get the price Item data by price item type URI. PriceItemData

Parameters:

uri - as String the uri of the price item type.

Returns:

PriceItemData.

Throws:

IMCException - the platform exception

getPriceItemByUri

public PriceItemData getPriceItemByUri(String uri)
                                throws IMCException

To get the price Item data by price item URI. PriceItemData

Parameters:

uri - as String the uri of the price item.

Returns:

PriceItemData.

Throws:

IMCException - the platform exception

getPriceItemsByTypeName

public List<PriceItemData> getPriceItemsByTypeName(String name)
                                            throws IMCException

To get all the price Item data by the name of the price item type. PriceItemData

Parameters:

name - as String the name of the price item type.

Returns:

PriceItemData.

Throws:

IMCException - the platform exception

getPriceItemsByTypeUri

public List<PriceItemData> getPriceItemsByTypeUri(String uri)
                                           throws IMCException

To get all the price Item data by the URI of the price item type . PriceItemData

Parameters:

uri - as String the URI of the price item type.

Returns:

PriceItemData in List

Throws:

IMCException - the platform exception

getPriceItemsJustified

public List<PriceItemData> getPriceItemsJustified(String justificationURI)
                                           throws IMCException

To get all justified price Item data. PriceItemData

Parameters:

justificationURI - as String

Returns:

PriceItemData in List

Throws:

IMCException - the platform exception

getProductErpId

public String getProductErpId()

Retrieves the ERP ID of this line item

Returns:

The ERP ID of this line item

getProductObjectName

public String getProductObjectName()

Retrieves the product name of this line item

Returns:

The full path of the product name of this line item

getProductTypeErpId

public String getProductTypeErpId()
                           throws IMCException

Retrieves the product type ERPID of this line item

Returns:

The product type URI of this line item

Throws:

IMCException - the platform exception

getProductTypeURI

public String getProductTypeURI()

Retrieves the product type URI of this line item

Returns:

The product type URI of this line item

getProductURI

public String getProductURI()

Retrieves the product URI of this line item

Returns:

The full path of the product URI of this line item

getQuantity

public BigDecimal getQuantity()
                       throws IMCException

Retrieves the quantity of this line item

Returns:

The quantity of this line item

Throws:

IMCException - the platform exception

getSalesItemURI

public String getSalesItemURI()
                       throws IMCException

Retrieves the URI of linked salesitem of this order item

Returns:

the URI of linked salesitem of this order item as String. Returns null for commerce order

Throws:

IMCException - the platform exception

setDataAttribute

public OrderItem setDataAttribute(String attributeURI,
                                  Object value)
                           throws IMCException

To set a value for the order item data attribute.

Parameters:

attributeURI - as String. The URI of the order item data attribute.

value - as Object. The value for the order item data attribute.

Returns:

The OrderItem

Throws:

IMCException - the platform exception

setRelationAttribute

public OrderItem setRelationAttribute(String attributeURI,
                                      String valueURI)
                               throws IMCException

To set a value for the order item relation attribute.

Parameters:

attributeURI - as String. The URI of the order item relation attribute.

valueURI - as Object. The value for the order item relation attribute.

Returns:

The OrderItem

Throws:

IMCException - the platform exception