Class IncludedItem

java.lang.Object
com.fourjs.report.facturx.profiles.extended.IncludedItem

public class IncludedItem extends Object
BG-X-1 Included Item — An included Item referenced from this trade product.

The EN 16931 business terms and groups implemented by this class:

Business terms and groups implemented
RepresentsBG-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:

BG-X-1 — Included Item
DescriptionENAn included Item referenced from this trade product.
Since:
1.09.2/2.5.2
  • Method Details

    • setSellerAssignedID

      public IncludedItem setSellerAssignedID(String value)
      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:SellerAssignedID

      FR: 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 IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setBuyerAssignedID

      public IncludedItem setBuyerAssignedID(String value)
      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:BuyerAssignedID

      FR: 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 IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setNameOfIncludedItem

      public IncludedItem setNameOfIncludedItem(String value)
      Sets BT-X-18 Name of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:Name

      FR: Nom du produit référencé inclus

      Parameters:
      value - the value to set
      Returns:
      this IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setDescriptionOfIncludedItem

      public IncludedItem setDescriptionOfIncludedItem(String value)
      Sets BT-X-19 Description of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:Description

      FR: Description du produit référencé inclus — Description d'un article.

      Parameters:
      value - the value to set
      Returns:
      this IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setIncludedQuantityofIncludedItem

      public IncludedItem setIncludedQuantityofIncludedItem(Quantity value)
      Sets BT-X-20 Included quantityof Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantity

      FR: UnitéQuantité du produit référencé inclus

      Parameters:
      value - the value to set
      Returns:
      this IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setMeasurementUnit

      public IncludedItem setMeasurementUnit(Codes.UnitOfMeasure value)
      Sets BT-X-20-1 Measurement unit.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantity/@unitCode

      FR: Unité de mesure

      Parameters:
      value - the value to set
      Returns:
      this IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setIDOfIncludedItem

      public IncludedItem setIDOfIncludedItem(String value)
      Sets BT-X-308 ID of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:ID

      FR: 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 IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • setIndustryAssignedIDOfIncludedItem

      public IncludedItem setIndustryAssignedIDOfIncludedItem(String value)
      Sets BT-X-309 Industry AssignedID of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:IndustryAssignedID

      FR: 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 IncludedItem for chaining
      Since:
      1.09.2/2.5.2
    • getSellerAssignedID

      public String 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:SellerAssignedID

      FR: ID du produit référencé contenu, attribué par le vendeur — Identifiant attribué par le Vendeur à un article.

      Returns:
      the BT-X-16 value
      Since:
      1.09.2/2.5.2
    • getBuyerAssignedID

      public String 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:BuyerAssignedID

      FR: ID attribué par l'acheteur au produit référencé inclus — Identifiant attribué par l'Acheteur à un article.

      Returns:
      the BT-X-17 value
      Since:
      1.09.2/2.5.2
    • getNameOfIncludedItem

      public String getNameOfIncludedItem()
      Returns BT-X-18 Name of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:Name

      FR: Nom du produit référencé inclus

      Returns:
      the BT-X-18 value
      Since:
      1.09.2/2.5.2
    • getDescriptionOfIncludedItem

      public String getDescriptionOfIncludedItem()
      Returns BT-X-19 Description of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:Description

      FR: Description du produit référencé inclus — Description d'un article.

      Returns:
      the BT-X-19 value
      Since:
      1.09.2/2.5.2
    • getIncludedQuantityofIncludedItem

      public Quantity getIncludedQuantityofIncludedItem()
      Returns BT-X-20 Included quantityof Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantity

      FR: UnitéQuantité du produit référencé inclus

      Returns:
      the BT-X-20 value
      Since:
      1.09.2/2.5.2
    • getMeasurementUnit

      public Codes.UnitOfMeasure getMeasurementUnit()
      Returns BT-X-20-1 Measurement unit.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:UnitQuantity/@unitCode

      FR: Unité de mesure

      Returns:
      the BT-X-20-1 value
      Since:
      1.09.2/2.5.2
    • getIDOfIncludedItem

      public String getIDOfIncludedItem()
      Returns BT-X-308 ID of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:ID

      FR: ID de produits inclus référencés — Identification de l'article pour l'interopérabilité avec Order-X

      Returns:
      the BT-X-308 value
      Since:
      1.09.2/2.5.2
    • getIndustryAssignedIDOfIncludedItem

      public String getIndustryAssignedIDOfIncludedItem()
      Returns BT-X-309 Industry AssignedID of Included Item.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:IncludedReferencedProduct/ram:IndustryAssignedID

      FR: 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-309 value
      Since:
      1.09.2/2.5.2
    • appendNewGlobalIDOfIncludedItem

      public GlobalIDOfIncludedItem appendNewGlobalIDOfIncludedItem(Codes.SchemeIdentifier schemeIdentifier, String globalIDOfIncludedItem)
      Creates, appends and returns a new GlobalIDOfIncludedItem (BT-X-15 GlobalID of Included Item).
      Parameters:
      schemeIdentifier - BT-X-15-1 Scheme identifier — The identification scheme identifier of the Item standard identifier

      Usage: 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

      public List<GlobalIDOfIncludedItem> getGlobalIDOfIncludedItems()