Class IncludedItem
BG-X-1 Included Item — An included Item referenced from this trade product.
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-X-1 |
|---|---|
| Business terms (value fields) | BT-X-16, BT-X-17, BT-X-18, BT-X-19, BT-X-20, BT-X-20-1, BT-X-308, BT-X-309 |
| Business groups (object lists) | BT-X-15 |
Documentation of the represented business group:
| Description | EN | An included Item referenced from this trade product. |
|---|
- Since:
- 1.09.2/2.5.2
-
Method Summary
Modifier and TypeMethodDescriptionappendNewGlobalIDOfIncludedItem(Codes.SchemeIdentifier schemeIdentifier, String globalIDOfIncludedItem) Creates, appends and returns a newGlobalIDOfIncludedItem(BT-X-15 GlobalID of Included Item).Returns BT-X-17 Included Item Buyer's identifier — An identifier, assigned by the Buyer, for the item.Returns BT-X-19 Description of Included Item.Returns BT-X-308 ID of Included Item.Returns BT-X-20 Included quantityof Included Item.Returns BT-X-309 Industry AssignedID of Included Item.Returns BT-X-20-1 Measurement unit.Returns BT-X-18 Name of Included Item.Returns BT-X-16 Included Item Seller's identifier — An identifier, assigned by the Seller, for the item.setBuyerAssignedID(String value) Sets BT-X-17 Included Item Buyer's identifier — An identifier, assigned by the Buyer, for the item.Sets BT-X-19 Description of Included Item.setIDOfIncludedItem(String value) Sets BT-X-308 ID of Included Item.Sets BT-X-20 Included quantityof Included Item.Sets BT-X-309 Industry AssignedID of Included Item.Sets BT-X-20-1 Measurement unit.setNameOfIncludedItem(String value) Sets BT-X-18 Name of Included Item.setSellerAssignedID(String value) Sets BT-X-16 Included Item Seller's identifier — An identifier, assigned by the Seller, for the item.
-
Method Details
-
setSellerAssignedID
Sets BT-X-16 Included Item Seller's identifier — An identifier, assigned by the Seller, for the item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:SellerAssignedIDFR: ID du produit référencé contenu, attribué par le vendeur — Identifiant attribué par le Vendeur à un article.
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setBuyerAssignedID
Sets BT-X-17 Included Item Buyer's identifier — An identifier, assigned by the Buyer, for the item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:BuyerAssignedIDFR: ID attribué par l'acheteur au produit référencé inclus — Identifiant attribué par l'Acheteur à un article.
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setNameOfIncludedItem
Sets BT-X-18 Name of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:NameFR: Nom du produit référencé inclus
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setDescriptionOfIncludedItem
Sets BT-X-19 Description of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:DescriptionFR: Description du produit référencé inclus — Description d'un article.
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setIncludedQuantityofIncludedItem
Sets BT-X-20 Included quantityof Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantityFR: UnitéQuantité du produit référencé inclus
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setMeasurementUnit
Sets BT-X-20-1 Measurement unit.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantity/@unitCodeFR: Unité de mesure
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setIDOfIncludedItem
Sets BT-X-308 ID of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:IDFR: ID de produits inclus référencés — Identification de l'article pour l'interopérabilité avec Order-X
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
setIndustryAssignedIDOfIncludedItem
Sets BT-X-309 Industry AssignedID of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:IndustryAssignedIDFR: ID attribué par l'industrie au produit référencé inclus — Identification de l'article pour l'interopérabilité avec Order-X
- Parameters:
value- the value to set- Returns:
- this
IncludedItemfor chaining - Since:
- 1.09.2/2.5.2
-
getSellerAssignedID
Returns BT-X-16 Included Item Seller's identifier — An identifier, assigned by the Seller, for the item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:SellerAssignedIDFR: ID du produit référencé contenu, attribué par le vendeur — Identifiant attribué par le Vendeur à un article.
- Returns:
- the
BT-X-16value - Since:
- 1.09.2/2.5.2
-
getBuyerAssignedID
Returns BT-X-17 Included Item Buyer's identifier — An identifier, assigned by the Buyer, for the item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:BuyerAssignedIDFR: ID attribué par l'acheteur au produit référencé inclus — Identifiant attribué par l'Acheteur à un article.
- Returns:
- the
BT-X-17value - Since:
- 1.09.2/2.5.2
-
getNameOfIncludedItem
Returns BT-X-18 Name of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:NameFR: Nom du produit référencé inclus
- Returns:
- the
BT-X-18value - Since:
- 1.09.2/2.5.2
-
getDescriptionOfIncludedItem
Returns BT-X-19 Description of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:DescriptionFR: Description du produit référencé inclus — Description d'un article.
- Returns:
- the
BT-X-19value - Since:
- 1.09.2/2.5.2
-
getIncludedQuantityofIncludedItem
Returns BT-X-20 Included quantityof Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantityFR: UnitéQuantité du produit référencé inclus
- Returns:
- the
BT-X-20value - Since:
- 1.09.2/2.5.2
-
getMeasurementUnit
Returns BT-X-20-1 Measurement unit.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantity/@unitCodeFR: Unité de mesure
- Returns:
- the
BT-X-20-1value - Since:
- 1.09.2/2.5.2
-
getIDOfIncludedItem
Returns BT-X-308 ID of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:IDFR: ID de produits inclus référencés — Identification de l'article pour l'interopérabilité avec Order-X
- Returns:
- the
BT-X-308value - Since:
- 1.09.2/2.5.2
-
getIndustryAssignedIDOfIncludedItem
Returns BT-X-309 Industry AssignedID of Included Item.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:IndustryAssignedIDFR: ID attribué par l'industrie au produit référencé inclus — Identification de l'article pour l'interopérabilité avec Order-X
- Returns:
- the
BT-X-309value - Since:
- 1.09.2/2.5.2
-
appendNewGlobalIDOfIncludedItem
public GlobalIDOfIncludedItem appendNewGlobalIDOfIncludedItem(Codes.SchemeIdentifier schemeIdentifier, String globalIDOfIncludedItem) Creates, appends and returns a newGlobalIDOfIncludedItem(BT-X-15 GlobalID of Included Item).- Parameters:
schemeIdentifier- BT-X-15-1 Scheme identifier — The identification scheme identifier of the Item standard identifierUsage: The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.
FR: Identifiant du schéma — Identifiant du schéma de l'identifiant standard de l'article
globalIDOfIncludedItem- BT-X-15 GlobalID of Included Item — An item identifier based on a registered scheme.FR: ID global du produit référencé inclus — Identifiant d'article basé sur un schéma enregistré.
- Returns:
- the new
GlobalIDOfIncludedItem - Since:
- 1.09.2/2.5.2
-
getGlobalIDOfIncludedItems
-