com.imc.iss.groovy.salesitem

Class SalesItemNode

java.lang.Object

com.imc.iss.groovy.salesitem.SalesItemNode

public class SalesItemNode
extends Object

This is a class representing a line item for use by groovy scripts.

Its instances should never exist independently, instead they should always be a child of either the SalesItemsTree or another SalesItemNode

See Also:

SalesItemsTree

Method Summary

Modifier and Type	Method and Description
void	addAttachmentFile(InputStream attachmentStream, String fileName, long fileSize, String attachmentType) Adds the attachment file as line item attachment
SalesItemNode	addChildByProductErpId(String productErpId) Adds a new line item under this object by specifying its ERP ID.
SalesItemNode	addChildByProductURI(String productURI) Adds a new line item under this object by specifying its Product URI.
SalesItemNode	addNewBusinessObjectData(BusinessObjectDataDTO businessObjectDataDTO) Create businessAttribute data and assign it to salesItem
SalesItemNode	addNewPriceItem(PriceItemData priceItemData) Create and Add Price Item data to salesItem, without triggering SSC pricing.
SalesItemNode	addPartnerFunctions(Collection<PartnerFunctionRecord> partnerFunctionRecords) Add partner function records into salesItem's Partner Function.
void	changeName(String newName) Alters the name of this line item
void	changeParent(SalesItemNode newParent) Moves this line item to be under a different line item
void	changeParent(SalesItemsTree newParent) Moves this line item to be directly under the quote
void	changeQuantity(BigDecimal newQty) Alters the quantity of this line item
SalesItemNode	copy() Copies the current line item.
void	delete() Deletes the current line item and all of its descendant nodes
void	deleteLineItemAttachment(BusinessObject[] attachmentIds) Delete multiple Line Item Attachments
SalesItemNode	deletePartnerFunctions(Collection<BusinessObject> partnerFunctionRecords) Remove partner function records into SalesItem's Partner Function.
SalesItemNode	deletePriceItem(PriceItemData priceItem) Remove Price Item data from salesItem, without triggering SSC pricing.
List<SalesItemNode>	filterChildrenByDynamicAttribute(String dynamicAttributeName, List<Object> dynamicAttributeValues) Retrieves the list of child line items that has dynamic attribute of one of the specified values
List<SalesItemNode>	filterChildrenByDynamicAttribute(String dynamicAttributeName, Object dynamicAttributeValue) Retrieves the list of child line items that has dynamic attribute of a specific value
List<SalesItemNode>	filterChildrenByProductERPID(List<String> productERPIDs) Retrieves the list of child line items that has one of the specified ERP IDs.
List<SalesItemNode>	filterChildrenByProductName(List<String> productNames) Retrieves the list of child line items that has one of the specified objectName
List<SalesItemNode>	filterChildrenByProductType(String productTypeURI) Retrieves the list of child line items that belongs to a particular Product Type only
AttachmentData	getAttachmentFile(String fileName) Get a attachment file by file name.
List<AttachmentData>	getAttachmentFiles() Get the list of the attachment file.
List<AttachmentData>	getAttachmentFilesByType(String fileType) Get the list of the attachment file by file type.
AttachmentFolderData	getAttachmentFolder(String folderName) Get an attachment folder by folder name.
List<AttachmentFolderData>	getAttachmentFolders() Get the list of the attachment folder.
List<SalesItemNode>	getChildren() Retrieves the list of all line items directly under this object
Object	getDynamicAttribute(String dynamicAttributeName) Retrieves the value of a dynamic attribute of this line item
String	getGeojson() To get the google map data.
Object	getItemHeaderDataAttributeValue(String attributeURI) To get the value of the Item Header Price Item
Object	getNewMaterialItemDataAttributeValue(String attributeURI) To get the value of the New Material Item * @param attributeURI as String the URI of the NewMaterialItem attribute
String	getNewMaterialItemRelAttributeObjectERPId(String attributeURI) To get the objectERPId value of the New Material Item * @param attributeURI as String the URI of the NewMaterialItem attribute
String	getNewMaterialItemRelAttributeObjectURI(String attributeURI) To get the URI value of the New Material Item * @param attributeURI as String the URI of the NewMaterialItem attribute
String	getObjectName() Retrieves the object name of this line item
SalesItemNode	getParent() Retrieves the parent of this line item
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 function of the line item
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 all the object URI for a type of 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 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.
Map<String,String>	getProductComments() To get all product comments.
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
Object	getSalesItemDataAttributeValue(String attributeURI) Return salesItem data attribute value by the attribute uri
String	getSalesItemRelationAttributeErpId(String attributeURI) Return salesItem relation attribute's ERPID by the attribute uri
String	getSalesItemRelationAttributeObjectId(String attributeURI) Return salesItem relation attribute's objectID by the attribute uri
String	getSalesItemRelationAttributeObjectName(String attributeURI) Return salesItem relation attribute's objectName by the attribute uri
String	getSalesItemRelationAttributeURI(String attributeURI) Return salesItem relation attribute's URI by the attribute uri
String	getSalesItemURI() Retrieves the object URI of sales item of this line item
boolean	hasDynamicAttribute(String dynamicAttributeName) Checks if this line item has a particular dynamic attribute
SalesItemNode	setDataAttribute(String attributeURI, Object value) Set the immediate data attribute to SalesItem
void	setDynamicAttribute(String dynamicAttributeName, Object dynamicAttributeValue) Sets the value of a dynamic attribute of this line item.
void	setDynamicAttributeIfExist(String dynamicAttributeName, Object dynamicAttributeValue) Sets the value of a dynamic attribute of this line item.
void	setGeojson(String geojson) Set the google map data for the salesItem
void	setItemHeaderData(String attributeURI, Object value) To set item header price item.
SalesItemNode	setPriceItemByTypeName(String priceItemTypeName, BigDecimal baseAmount) Create or Update price item with baseAmount only.
SalesItemNode	setRelationAttribute(String attributeURI, String valueURI) Set the immediate relation attribute to SalesItem
SalesItemNode	split(BigDecimal splitQuantity) Splits the line item based on the given quantity.
SalesItemNode	updatePriceItemBaseAmount(String priceItemURI, BigDecimal baseAmount) Update BaseAmount with targetCurrency of a Price Item
SalesItemNode	updatePriceItemBaseCurrency(String priceItemURI, String baseCurrencyUri) Update baseCurrencyUri of a Price Item
SalesItemNode	updatePriceItemBaseQuantity(String priceItemURI, BigDecimal baseQuantity) Update BaseQuantity with UoM of a Price Item
SalesItemNode	updatePriceItemBaseUnitUoM(String priceItemURI, String baseUnitUoMUri, String baseUnitUoMName) Update baseUnitUoMUri and baseUnitUoMName of a Price Item
SalesItemNode	updatePriceItemConditionIsInactive(String priceItemURI, boolean conditionIsInactive) Update sequence of a Price Item
SalesItemNode	updatePriceItemJustification(String priceItemURI, String uri) Update Justification of a Price Item
SalesItemNode	updatePriceItemSequence(String priceItemURI, int sequenceID) Update sequence of a Price Item
SalesItemNode	updatePriceItemTargetAmount(String priceItemURI, BigDecimal targetAmount) Update TargetAmount of a Price Item
SalesItemNode	updatePriceItemTargetCurrency(String priceItemURI, String targetCurrencyUri) Update TargetCurrency of a Price Item

Methods inherited from class java.lang.Object

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

Method Detail

addAttachmentFile

public void addAttachmentFile(InputStream attachmentStream,
                              String fileName,
                              long fileSize,
                              String attachmentType)
                       throws IMCException

Adds the attachment file as line item attachment

Parameters:

attachmentStream - Input File Stream

fileName - Name of the file to be added

fileSize - Size of the File to be added

attachmentType - type of attachment File

Throws:

IMCException

addChildByProductErpId

public SalesItemNode addChildByProductErpId(String productErpId)
                                     throws IMCException

Adds a new line item under this object by specifying its ERP ID.

The validity of the given ERP ID will only be evaluated after the script has completed its execution and returns control back to the main application.

Parameters:

productErpId - The ERP ID of the product to be added as the new line item

Returns:

The SalesItemNode object representing the newly added line item

Throws:

IMCException

addChildByProductURI

public SalesItemNode addChildByProductURI(String productURI)
                                   throws IMCException

Adds a new line item under this object by specifying its Product URI.

The validity of the given URI will only be evaluated after the script has completed its execution and returns control back to the main application.

Parameters:

productURI - The URI of the product to be added as the new line item. The full path has to be provided.

Returns:

The SalesItemNode object representing the newly added line item

Throws:

IMCException

addNewBusinessObjectData

public SalesItemNode addNewBusinessObjectData(BusinessObjectDataDTO businessObjectDataDTO)

Create businessAttribute data and assign it to salesItem

Parameters:

businessObjectDataDTO - as BusinessObjectDataDTO. See BusinessObjectDataDTO

Returns:

SalesItemNode

addNewPriceItem

public SalesItemNode addNewPriceItem(PriceItemData priceItemData)
                              throws IMCException

Create and Add Price Item data to salesItem, without triggering SSC pricing. Should not be used unless that is the intention

Parameters:

priceItemData - as PriceItemData. See PriceItemData

Returns:

SalesItemNode

Throws:

IMCException

addPartnerFunctions

public SalesItemNode addPartnerFunctions(Collection<PartnerFunctionRecord> partnerFunctionRecords)

Add partner function records into salesItem's Partner Function.

Parameters:

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

Returns:

The SalesItemNode instance.

changeName

public void changeName(String newName)
                throws IMCException

Alters the name of this line item

Parameters:

newName - The new name

Throws:

IMCException

changeParent

public void changeParent(SalesItemNode newParent)
                  throws IMCException

Moves this line item to be under a different line item

Parameters:

newParent - The SalesItemNode object (i.e. a line item) that will become the new parent of this line item

Throws:

IMCException - If trying to set the parent to be one of it's own descendant node or its own self

changeParent

public void changeParent(SalesItemsTree newParent)
                  throws IMCException

Moves this line item to be directly under the quote

Parameters:

newParent - The SalesItemsTree object (i.e. the quote) that will become the new parent of this line item

Throws:

IMCException - If trying to set the parent to be one of it's own descendant node or its own self

changeQuantity

public void changeQuantity(BigDecimal newQty)
                    throws IMCException

Alters the quantity of this line item

Parameters:

newQty - The new quantity

Throws:

IMCException

copy

public SalesItemNode copy()
                   throws IMCException

Copies the current line item.

The copied node will be created with identical properties as the original, and will be placed under the same parent. Only the current line item will be copied, not any of its children

Returns:

The SalesItemNode object representing the newly added line item

Throws:

IMCException

delete

public void delete()

Deletes the current line item and all of its descendant nodes

deleteLineItemAttachment

public void deleteLineItemAttachment(BusinessObject[] attachmentIds)
                              throws IMCException

Delete multiple Line Item Attachments

Throws:

IMCException

deletePartnerFunctions

public SalesItemNode deletePartnerFunctions(Collection<BusinessObject> partnerFunctionRecords)
                                     throws IMCException

Remove partner function records into SalesItem's Partner Function.

Parameters:

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

Returns:

The SalesItem instance.

Throws:

IMCException

deletePriceItem

public SalesItemNode deletePriceItem(PriceItemData priceItem)
                              throws IMCException

Remove Price Item data from salesItem, without triggering SSC pricing. Should not be used unless that is the intention

Parameters:

priceItemData - as PriceItemData. See PriceItemData

Returns:

SalesItemNode

Throws:

IMCException

filterChildrenByDynamicAttribute

public List<SalesItemNode> filterChildrenByDynamicAttribute(String dynamicAttributeName,
                                                            List<Object> dynamicAttributeValues)
                                                     throws IMCException

Retrieves the list of child line items that has dynamic attribute of one of the specified values

Parameters:

dynamicAttributeName - The object name of the dynamic attribute. It can be either Dynamic Symbolic Attribute (DSA) or Dynamic Data Attribute (DDA). Note that only the object name can be used here, not the language-specific labels

dynamicAttributeValues - The list of acceptable values for the dynamic attribute. For DSA, only the object name of the ranges can be used here, not the language-specific labels

Returns:

All SalesItemNode objects directly under this object that meets the filter criteria

Throws:

IMCException

filterChildrenByDynamicAttribute

public List<SalesItemNode> filterChildrenByDynamicAttribute(String dynamicAttributeName,
                                                            Object dynamicAttributeValue)
                                                     throws IMCException

Retrieves the list of child line items that has dynamic attribute of a specific value

Parameters:

dynamicAttributeName - The object name of the dynamic attribute. It can be either Dynamic Symbolic Attribute (DSA) or Dynamic Data Attribute (DDA). Note that only the object name can be used here, not the language-specific labels

dynamicAttributeValue - The accepted value for the dynamic attribute. For DSA, only the object name of the ranges can be used here, not the language-specific labels

Returns:

All SalesItemNode objects directly under this object that meets the filter criteria

Throws:

IMCException

filterChildrenByProductERPID

public List<SalesItemNode> filterChildrenByProductERPID(List<String> productERPIDs)

Retrieves the list of child line items that has one of the specified ERP IDs.

Parameters:

productERPIDs - The list of accepted values of ERP ID

Returns:

All SalesItemNode objects directly under this object that meets the filter criteria

filterChildrenByProductName

public List<SalesItemNode> filterChildrenByProductName(List<String> productNames)

Retrieves the list of child line items that has one of the specified objectName

Parameters:

productNames - The list of accepted values of product object name

Returns:

All SalesItemNode objects directly under this object that meets the filter criteria

filterChildrenByProductType

public List<SalesItemNode> filterChildrenByProductType(String productTypeURI)

Retrieves the list of child line items that belongs to a particular Product Type only

Parameters:

productTypeURI - The URI of the product type. The full path has to be provided.

Returns:

All SalesItemNode objects directly under this object that meets the filter criteria

getAttachmentFile

public AttachmentData getAttachmentFile(String fileName)
                                 throws IMCException

Get a attachment file by file name. @see AttachmentData.

Parameters:

fileName - as String the name of the file.

Returns:

AttachmentData.

Throws:

IMCException

getAttachmentFiles

public List<AttachmentData> getAttachmentFiles()
                                        throws IMCException

Get the list of the attachment file.

Returns:

AttachmentData in List.

Throws:

IMCException

See Also:

AttachmentData}.

getAttachmentFilesByType

public List<AttachmentData> getAttachmentFilesByType(String fileType)
                                              throws IMCException

Get the list of the attachment file by file type. @see AttachmentData.

Parameters:

fileType - as String. The file type.

Returns:

AttachmentData in List.

Throws:

IMCException

getAttachmentFolder

public AttachmentFolderData getAttachmentFolder(String folderName)
                                         throws IMCException

Get an attachment folder by folder name.

Parameters:

folderName - the name of the folder.

Returns:

AttachmentFolderData.

Throws:

IMCException

See Also:

AttachmentFolderData}.

getAttachmentFolders

public List<AttachmentFolderData> getAttachmentFolders()
                                                throws IMCException

Get the list of the attachment folder.

Returns:

AttachmentFolderData in List.

Throws:

IMCException

See Also:

AttachmentFolderData}.

getChildren

public List<SalesItemNode> getChildren()

Retrieves the list of all line items directly under this object

Returns:

All SalesItemNode objects directly under this object

getDynamicAttribute

public Object getDynamicAttribute(String dynamicAttributeName)
                           throws IMCException

Retrieves the value of a dynamic attribute of this line item

Parameters:

dynamicAttributeName - The object name of the dynamic attribute. It can be either Dynamic Symbolic Attribute (DSA) or Dynamic Data Attribute (DDA). Note that only the object name can be used here, not the language-specific labels

Returns:

The value of the dynamic attribute, or null if the line item does not have such a dynamic attribute

Throws:

IMCException

getGeojson

public String getGeojson()
                  throws IMCException

To get the google map data. Use MapUtil to manipulate it.

Returns:

the google map data as String.

Throws:

IMCException

See Also:

http://geojson.org

getItemHeaderDataAttributeValue

public Object getItemHeaderDataAttributeValue(String attributeURI)
                                       throws IMCException

To get the value of the Item Header Price Item

Parameters:

attributeURI - as String the URI of the itemHeaderPriceItem attribute

Returns:

the value as Object

Throws:

IMCException

getNewMaterialItemDataAttributeValue

public Object getNewMaterialItemDataAttributeValue(String attributeURI)
                                            throws IMCException

To get the value of the New Material Item * @param attributeURI as String the URI of the NewMaterialItem attribute

Parameters:

attributeURI - as String the Data URI of the NewMaterialItem

Returns:

the value as Object

Throws:

IMCException

getNewMaterialItemRelAttributeObjectERPId

public String getNewMaterialItemRelAttributeObjectERPId(String attributeURI)
                                                 throws IMCException

To get the objectERPId value of the New Material Item * @param attributeURI as String the URI of the NewMaterialItem attribute

Parameters:

attributeURI - as String the Relation URI of the NewMaterialItem

Returns:

the objectERPId of the relation attribute as String

Throws:

IMCException

getNewMaterialItemRelAttributeObjectURI

public String getNewMaterialItemRelAttributeObjectURI(String attributeURI)
                                               throws IMCException

To get the URI value of the New Material Item * @param attributeURI as String the URI of the NewMaterialItem attribute

Parameters:

attributeURI - as String the Relation URI of the NewMaterialItem

Returns:

the URI of the relation attribute as String

Throws:

IMCException

getObjectName

public String getObjectName()
                     throws IMCException

Retrieves the object name of this line item

Returns:

The object name of this line item

Throws:

IMCException

getParent

public SalesItemNode getParent()

Retrieves the parent of this line item

Returns:

The SalesItemNode object representing the parent of this line item, or null if this is a top level line item (i.e. the parent is the SalesItemsTree object)

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 ERPId for the partner function as String. null if not found.

Throws:

IMCException

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

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

getPartners

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

Retrieves the partner function of the line item

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

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

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

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

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

getPartnerURI

public String getPartnerURI(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

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

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

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

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

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

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

getProductComments

public Map<String,String> getProductComments()
                                      throws IMCException

To get all product comments.

Returns:

a map whose key is language and value is comment.

Throws:

IMCException

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

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

getSalesItemDataAttributeValue

public Object getSalesItemDataAttributeValue(String attributeURI)
                                      throws IMCException

Return salesItem data attribute value by the attribute uri

Parameters:

attributeURI - as String. The uri of the attribute

Returns:

the value of the data attribute as Object

Throws:

IMCException

getSalesItemRelationAttributeErpId

public String getSalesItemRelationAttributeErpId(String attributeURI)
                                          throws IMCException

Return salesItem relation attribute's ERPID by the attribute uri

Parameters:

attributeURI - as String. The uri of the attribute

Returns:

the erpID of the data attribute as String

Throws:

IMCException

getSalesItemRelationAttributeObjectId

public String getSalesItemRelationAttributeObjectId(String attributeURI)
                                             throws IMCException

Return salesItem relation attribute's objectID by the attribute uri

Parameters:

attributeURI - as String. The uri of the attribute

Returns:

the objectID of the data attribute as String

Throws:

IMCException

getSalesItemRelationAttributeObjectName

public String getSalesItemRelationAttributeObjectName(String attributeURI)
                                               throws IMCException

Return salesItem relation attribute's objectName by the attribute uri

Parameters:

attributeURI - as String. The uri of the attribute

Returns:

the objectName of the data attribute as String

Throws:

IMCException

getSalesItemRelationAttributeURI

public String getSalesItemRelationAttributeURI(String attributeURI)
                                        throws IMCException

Return salesItem relation attribute's URI by the attribute uri

Parameters:

attributeURI - as String. The uri of the attribute

Returns:

the URI as String of the data attribute

Throws:

IMCException

getSalesItemURI

public String getSalesItemURI()

Retrieves the object URI of sales item of this line item

Returns:

The full path of the sales item URI of this line item

hasDynamicAttribute

public boolean hasDynamicAttribute(String dynamicAttributeName)
                            throws IMCException

Checks if this line item has a particular dynamic attribute

Parameters:

dynamicAttributeName - The object name of the dynamic attribute. It can be either Dynamic Symbolic Attribute (DSA) or Dynamic Data Attribute (DDA). Note that only the object name can be used here, not the language-specific labels

Returns:

True if the line item has the dynamic attribute

Throws:

IMCException

setDataAttribute

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

Set the immediate data attribute to SalesItem

Parameters:

attributeURI - as String. The uri of the Business Data Attribute

value - as Object. The value of the object.

Returns:

SalesItemNode

Throws:

IMCException

setDynamicAttribute

public void setDynamicAttribute(String dynamicAttributeName,
                                Object dynamicAttributeValue)
                         throws IMCException

Sets the value of a dynamic attribute of this line item.

The validity of the given dynamic attribute or its value will only be evaluated after the script has completed its execution and returns control back to the main application.

Parameters:

dynamicAttributeName - The object name of the dynamic attribute. It can be either Dynamic Symbolic Attribute (DSA) or Dynamic Data Attribute (DDA). Note that only the object name can be used here, not the language-specific labels

dynamicAttributeValue - The value to be set for the dynamic attribute. For DSA, only the object name of the ranges can be used here, not the language-specific labels

Throws:

IMCException - the platform exception

setDynamicAttributeIfExist

public void setDynamicAttributeIfExist(String dynamicAttributeName,
                                       Object dynamicAttributeValue)
                                throws IMCException

Sets the value of a dynamic attribute of this line item.

The existence of the given dynamic attribute will NOT be checked, if the sales item does not have such a DA, it will be silently ignored and will not result in an exception. If the dynamic attribute exists, the validity of the value will still be evaluated after the script has completed its execution and returns control back to the main application.

This method will still throw exception if used on a Sales Item that is a non-configurable product

Parameters:

dynamicAttributeName - The object name of the dynamic attribute. It can be either Dynamic Symbolic Attribute (DSA) or Dynamic Data Attribute (DDA). Note that only the object name can be used here, not the language-specific labels

dynamicAttributeValue - The value to be set for the dynamic attribute. For DSA, only the object name of the ranges can be used here, not the language-specific labels

Throws:

IMCException - the platform exception

setGeojson

public void setGeojson(String geojson)

Set the google map data for the salesItem

See Also:

http://geojson.org

setItemHeaderData

public void setItemHeaderData(String attributeURI,
                              Object value)
                       throws IMCException

To set item header price item.

Parameters:

attributeURI - as String. The URI of the price item.

value - as Object. The value for the price item.

Throws:

IMCException

setPriceItemByTypeName

public SalesItemNode setPriceItemByTypeName(String priceItemTypeName,
                                            BigDecimal baseAmount)
                                     throws IMCException

Create or Update price item with baseAmount only.

Note that this method assumes that there can only be one Price Item of a given type. Thus, if a Price Item of that type already exists it will update it, otherwise it will create a new Price Item. If there are already multiple Price Items of the given type, only the first one will be updated.

Parameters:

priceItemTypeName - as String. The name of the priceItemType

baseAmount - as BigDecimal. The baseAmount to update / create.

Returns:

SalesItemNode

Throws:

IMCException

setRelationAttribute

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

Set the immediate relation attribute to SalesItem

Parameters:

attributeURI - as String. The uri of the Business Relation Attribute

URI - as String. The uri of the object.

Returns:

SalesItemNode

Throws:

IMCException

split

public SalesItemNode split(BigDecimal splitQuantity)
                    throws IMCException

Splits the line item based on the given quantity.

This will create a copy of the current item. The new item will have the given quantity, while the quantity of the current item will be reduced by the same amount. For example, if originally the line item has a quantity of 10, and this method is called with splitQuantity = 3, the original line item will now have quantity of 7 while the new line item will have quantity of 3.

Children of the current line items will not be copied over and will remain with the original item. All other properties such as quantity or dynamic attributes will be copied.

Parameters:

splitQuantity - The quantity of the new line item. The quantity of the current item will be reduced by the same amount

Returns:

The SalesItemNode object representing the newly added line item

Throws:

IMCException

updatePriceItemBaseAmount

public SalesItemNode updatePriceItemBaseAmount(String priceItemURI,
                                               BigDecimal baseAmount)
                                        throws IMCException

Update BaseAmount with targetCurrency of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

baseAmount - as BigDecimal. The BaseAmount of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemBaseCurrency

public SalesItemNode updatePriceItemBaseCurrency(String priceItemURI,
                                                 String baseCurrencyUri)
                                          throws IMCException

Update baseCurrencyUri of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

baseCurrencyUri - as String. The base Currency Uri of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemBaseQuantity

public SalesItemNode updatePriceItemBaseQuantity(String priceItemURI,
                                                 BigDecimal baseQuantity)
                                          throws IMCException

Update BaseQuantity with UoM of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

baseQuantity - as BigDecimal. The Base Quantity value (base condition unit) of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemBaseUnitUoM

public SalesItemNode updatePriceItemBaseUnitUoM(String priceItemURI,
                                                String baseUnitUoMUri,
                                                String baseUnitUoMName)
                                         throws IMCException

Update baseUnitUoMUri and baseUnitUoMName of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

baseUnitUoMUri - as String. The base unit UoM Uri of the price item.

baseUnitUoMName - as String. The base unit UoM Name of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemConditionIsInactive

public SalesItemNode updatePriceItemConditionIsInactive(String priceItemURI,
                                                        boolean conditionIsInactive)
                                                 throws IMCException

Update sequence of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

sequenceID - as int. The sequence of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemJustification

public SalesItemNode updatePriceItemJustification(String priceItemURI,
                                                  String uri)
                                           throws IMCException

Update Justification of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

uri - as String. The URI of the justification. (http://www.inmindcloud.com/application/schema.owl#UserJustified or http://www.inmindcloud.com/application/schema.owl#SystemJustifiedERP)

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemSequence

public SalesItemNode updatePriceItemSequence(String priceItemURI,
                                             int sequenceID)
                                      throws IMCException

Update sequence of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

sequenceID - as int. The sequence of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemTargetAmount

public SalesItemNode updatePriceItemTargetAmount(String priceItemURI,
                                                 BigDecimal targetAmount)
                                          throws IMCException

Update TargetAmount of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

targetAmount - as BigDecimal. The targetAmount of the price item.

Returns:

SalesItemNode

Throws:

IMCException

updatePriceItemTargetCurrency

public SalesItemNode updatePriceItemTargetCurrency(String priceItemURI,
                                                   String targetCurrencyUri)
                                            throws IMCException

Update TargetCurrency of a Price Item

Parameters:

priceItemURI - as String. The URI of the price item to be updated.

targetCurrencyUri - as String. The target Currency Uri of the price item.

Returns:

SalesItemNode

Throws:

IMCException