com.imc.iss.groovy.order

Class Order

java.lang.Object

com.imc.iss.groovy.order.Order

public class Order
extends Object

Order class

Since:

2102

Constructor Summary

Constructors

Constructor and Description
Order()

Method Summary

Modifier and Type	Method and Description
Order	addPartnerFunctions(Collection<PartnerFunctionRecord> partnerFunctionRecords) Add partner function records into order's Partner Function.
Order	deletePartnerFunctions(Collection<BusinessObject> partnerFunctionRecords) Remove partner function records into Order's Partner Function.
List<OrderItem>	getChildren() Retrieves the list of all line items directly under this object
Object	getOrderDataAttributeValue(String attributeURI) To get the value of a order data attribute by attribute URI.
String	getOrderRelationAttributeErpId(String attributeURI) To get the ERPID of a order relation attribute by attribute URI.
String	getOrderRelationAttributeObjectId(String attributeURI) To get the object Id of a order relation attribute by attribute URI.
String	getOrderRelationAttributeObjectName(String attributeURI) To get the object name of a order relation attribute by attribute URI.
String	getOrderRelationAttributeURI(String attributeURI) To get the URI of a order relation attribute by attribute URI.
String	getOrderURI() Get the order uri as String.
String	getPartnerErpId(String PartnerFunctionURI) To get the ERPId of the partner function by partner function URI.
String	getPartnerObjectId(String partnerFunctionURI) To get the object Id of the partner function by partner function URI.
String	getPartnerObjectName(String partnerFunctionURI) To get the object Name of the partner function by partner function URI.
Map<String,List<AbstractObjectDTO>>	getPartners() Retrieves the partner functions of the quote.
List<String>	getPartnersErpId(String partnerFunctionURI) To get all the ERPId for a type of partner function.
List<String>	getPartnersObjectId(String partnerFunctionURI) To get all the object Id for a type of partner function.
List<String>	getPartnersObjectName(String partnerFunctionURI) To get all the object names for a type of partner function.
List<String>	getPartnersURI(String partnerFunctionURI) To get all the object URI for a type of partner function.
String	getPartnerURI(String PartnerFunctionURI) To get the object URI of a partner function
PriceItemData	getPriceItemByTypeName(String name) To get the price Item data by name.
PriceItemData	getPriceItemByTypeUri(String uri) To get the price Item data by 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 price item URI.
List<PriceItemData>	getPriceItemsJustified(String justificationURI) To get all user justified price Item data.
String	getQuoteURI() To get associated quote URI.
SalesItemsTree	getSalesItemsTree() To get linked salesItemsTree of the order.
boolean	isCommerce() Indicates the context that order object is created from
Order	setDataAttribute(String attributeURI, Object value) To set a value for the order data attribute.
Order	setRelationAttribute(String attributeURI, String valueURI) To set a value for the order relation attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

Order

public Order()

Method Detail

addPartnerFunctions

public Order addPartnerFunctions(Collection<PartnerFunctionRecord> partnerFunctionRecords)

Add partner function records into order's Partner Function.

Parameters:

partnerFunctionRecords. - The partner function records to add into a order.

Returns:

The Order instance.

deletePartnerFunctions

public Order deletePartnerFunctions(Collection<BusinessObject> partnerFunctionRecords)

Remove partner function records into Order's Partner Function.

Parameters:

partnerFunctionRecords. - The partner function records to remove into a Order.

Returns:

The Order instance.

Throws:

IMCException

getChildren

public List<OrderItem> getChildren()

Retrieves the list of all line items directly under this object

Returns:

All OrderItem objects directly under this object

getOrderDataAttributeValue

public Object getOrderDataAttributeValue(String attributeURI)
                                  throws IMCException

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

Parameters:

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

Returns:

the value of the order data attribute as Object.

Throws:

IMCException - the platform exception

getOrderRelationAttributeErpId

public String getOrderRelationAttributeErpId(String attributeURI)
                                      throws IMCException

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

Parameters:

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

Returns:

the ERPId of the order relation attribute as String.

Throws:

IMCException - the platform exception

getOrderRelationAttributeObjectId

public String getOrderRelationAttributeObjectId(String attributeURI)
                                         throws IMCException

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

Parameters:

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

Returns:

the objectId of the order relation attribute as String.

Throws:

IMCException - the platform exception

getOrderRelationAttributeObjectName

public String getOrderRelationAttributeObjectName(String attributeURI)
                                           throws IMCException

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

Parameters:

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

Returns:

the object name of the order relation attribute as String.

Throws:

IMCException - the platform exception

getOrderRelationAttributeURI

public String getOrderRelationAttributeURI(String attributeURI)
                                    throws IMCException

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

Parameters:

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

Returns:

the object URI of the order relation attribute as String.

Throws:

IMCException - the platform exception

getOrderURI

public String getOrderURI()

Get the order uri as String.

Returns:

the orderURI

getPartnerErpId

public String getPartnerErpId(String PartnerFunctionURI)
                       throws IMCException

To get the ERPId of the partner function by partner function URI.

Parameters:

PartnerFunctionURI - the URI of the partner function.

Returns:

The partner function ERPId as String. null if not found.

Throws:

IMCException - the platform exception

getPartnerObjectId

public String getPartnerObjectId(String partnerFunctionURI)
                          throws IMCException

To get the object Id of the partner function by partner function URI.

Parameters:

partnerFunctionURI - the URI of the partner function.

Returns:

The partner function object Id as String. null if not found.

Throws:

IMCException - the platform exception

getPartnerObjectName

public String getPartnerObjectName(String partnerFunctionURI)
                            throws IMCException

To get the object Name of the partner function by partner function URI.

Parameters:

partnerFunctionURI - the URI of the partner function.

Returns:

The partner function object Id as String. null if not found.

Throws:

IMCException - the platform exception

getPartners

public Map<String,List<AbstractObjectDTO>> getPartners()
                                                throws IMCException

Retrieves the partner functions of the quote.

Returns:

The partners as Map<String, List<AbstractObjectDTO>> with the uri of the partner function as key (eg: http://www.inmindcloud.com/application/schema.owl#BUYER_PARTY)

Throws:

IMCException - the platform exception

getPartnersErpId

public List<String> getPartnersErpId(String partnerFunctionURI)
                              throws IMCException

To get all the ERPId for a type of partner function.

Parameters:

partnerFunctionURI - the URI of the partner function.

Returns:

List of erpId in String.

Throws:

IMCException - the platform exception

getPartnersObjectId

public List<String> getPartnersObjectId(String partnerFunctionURI)
                                 throws IMCException

To get all the object Id for a type of partner function.

Parameters:

partnerFunctionURI - the URI of the partner function.

Returns:

List of object Id in String.

Throws:

IMCException - the platform exception

getPartnersObjectName

public List<String> getPartnersObjectName(String partnerFunctionURI)
                                   throws IMCException

To get all the object names for a type of partner function.

Parameters:

partnerFunctionURI - the URI of the partner function.

Returns:

List of object name in String.

Throws:

IMCException - the platform exception

getPartnersURI

public List<String> getPartnersURI(String partnerFunctionURI)
                            throws IMCException

To get all the object URI for a type of partner function.

Parameters:

partnerFunctionURI - the URI of the partner function.

Returns:

List of object URI in String.

Throws:

IMCException - the platform exception

getPartnerURI

public String getPartnerURI(String PartnerFunctionURI)
                     throws IMCException

To get the object URI of a partner function

Parameters:

PartnerFunctionURI - as String. The URI of the type of partner function.

Returns:

The object URI of the partner function as String. null if not found.

Throws:

IMCException - the platform exception

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 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 price item URI. 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 user justified price Item data. PriceItemData.

Parameters:

justificationURI - as String. It can be URI of either UserJustified or SystemJustified

Returns:

PriceItemData in List

Throws:

IMCException - the platform exception

getQuoteURI

public String getQuoteURI()
                   throws IMCException

To get associated quote URI.

Returns:

The associated quote URI as String. null if not found.

Throws:

IMCException - the platform exception

getSalesItemsTree

public SalesItemsTree getSalesItemsTree()
                                 throws IMCException

To get linked salesItemsTree of the order. SalesItemsTree.

Returns:

The linked salesItemTree SalesItemsTree. null if not found.

Throws:

IMCException - the platform exception

isCommerce

public boolean isCommerce()

Indicates the context that order object is created from

Returns:

the isCommerce as boolean. Return TRUE if it is commerce order.

setDataAttribute

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

To set a value for the order data attribute.

Parameters:

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

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

Returns:

The Order

Throws:

IMCException - the platform exception

setRelationAttribute

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

To set a value for the order relation attribute.

Parameters:

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

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

Returns:

The Order

Throws:

IMCException - the platform exception