Package de.aeb.xnsg.expctrl.bf.v40

Class ECItemDTO

java.lang.Object
de.aeb.xnsg.expctrl.bf.v40.ECItemDTO
public class ECItemDTO extends Object
One item of a transaction to be checked for export control restrictions.

  • Field Details

    • FINAL_USAGES_SEPARATOR

      public static final String FINAL_USAGES_SEPARATOR
      Separates final usages.
      See Also:

    • FINAL_USAGE_NONE

      public static final String FINAL_USAGE_NONE
      Indicates that there is no special end-use.
      See Also:

    • FINAL_USAGE_ALL

      public static final String FINAL_USAGE_ALL
      Indicates that all end-uses are possible.
      See Also:

    • FINAL_USAGE_ABC_NUCLEAR_WEAPONS

      public static final String FINAL_USAGE_ABC_NUCLEAR_WEAPONS
      Indicates NBC weapons incl. missile technology as end-use.
      See Also:

    • FINAL_USAGE_NUCLEARPLANTS

      public static final String FINAL_USAGE_NUCLEARPLANTS
      Indicates nuclear plants as end-use.
      See Also:

    • FINAL_USAGE_CONVENTIONAL_WEAPONS

      public static final String FINAL_USAGE_CONVENTIONAL_WEAPONS
      Indicates a military end-use.
      See Also:

    • FINAL_USAGE_ILLEGALEXPORTEDWEAPONS

      public static final String FINAL_USAGE_ILLEGALEXPORTEDWEAPONS
      Indicates illegally exported munitions as end-use.
      See Also:

    • FINAL_USAGE_MILITARY_CONSIGNEE

      public static final String FINAL_USAGE_MILITARY_CONSIGNEE
      Indicates a military consignee as end-use.
      See Also:

    • FINAL_USAGE_FREE_TRADE_ZONE

      public static final String FINAL_USAGE_FREE_TRADE_ZONE
      Indicates a bonded warehouse or free trade zone as end-use.
      See Also:

    • FINAL_USAGE_CYBERSURVEILLANCE_HUMANRIGHTS

      public static final String FINAL_USAGE_CYBERSURVEILLANCE_HUMANRIGHTS
      Indicates cyber surveillance as end-use.
      See Also:

    • itemIdHost

      public String itemIdHost
      Mandatory field
      Unique id for the item within the transaction.

      Example value: 4711

    • itemLabelHost

      public String itemLabelHost
      Human-readable label for the item.

      Example value: Positionsnr. = 4711

    • mainApprovalItemTransIdHost

      public String mainApprovalItemTransIdHost

      Unique id of the transaction which includes the item that contains the main approvals. Has to be specified along with the mainApprovalItemIdHost.

      Used by IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO) to replace the necessity to specify the main approvals directly using uniqueParentClearingIds.

      Maximum length: 255
      Since:
      2019/11
      See Also:

    • mainApprovalItemIdHost

      public String mainApprovalItemIdHost

      Unique id of the transaction item that contains the main approvals within the transaction of the specified mainApprovalItemTransIdHost (has to be specified along with it).

      The item of the main approvals is especially used for automatic creation of partial approvals. If such an item is specified and there is not yet an approval for a certain jurisdiction, the approval will be created as partial approval based on the main approval of the appropriate jurisdiction.

      If the parent item does not exist, an error occurs.

      Used by IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO) to replace the necessity to specify the main approvals directly using uniqueParentClearingIds.

      Maximum length: 255
      Since:
      2019/11
      See Also:

    • bomItems

      public ECItemDTO[] bomItems
      The BOM (=bill of materials) sub items belonging to this item.
      Items in this array will be ignored for calls to IExportControl40BF.proposeLicenses(LMProposeLicensesRequestDTO) . Instead, for the license proposal, fill the BOM sub items into ECTransactionDTO.items, as if they were normal items.
      Note that only two-level item hierarchies are allowed, i.e. the bomItems may only contain items that have no bomItems themselves.
      Since:
      2016/05

    • isDirty

      @Deprecated public Boolean isDirty
      Deprecated.
      As of 2019/05. No longer required due to the new method to check transactions in Export Controls IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO).
      If true, there has been a change in the check relevant data of this item, and Trade Compliance Management will respond the status "check".
      Note: If the flag ECClearingDTO.allowOnlyMatchingLicense is set to true, the validation of transaction item data and their corresponding approvals will be done by Trade Compliance Management. Therefore, this flag is not necessary and will be ignored.

    • ctrySourceIso

      @Deprecated public String ctrySourceIso
      Deprecated.
      As of 2016/05. Use ECPartnerDTO.countryIso of the corresponding partner instead.
      Two-letter ISO code of the source country. This is the country where the transport of the goods starts. This field is mandatory if no consignor is defined.
      Maximum length: 2

    • ctryRecipientIso

      @Deprecated public String ctryRecipientIso
      Deprecated.
      As of 2016/05. Use ECPartnerDTO.countryIso of the corresponding partner instead.
      Two-letter ISO code of the recipients country. This is the country where the transport of the goods ends. This field is mandatory if no recipient is defined.
      Maximum length: 2

    • recipient

      @Deprecated public ECPartnerDTO recipient
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the recipient of the goods. This field is optional. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • ctryBuyerIso

      @Deprecated public String ctryBuyerIso
      Deprecated.
      As of 2016/05. Use ECPartnerDTO.countryIso of the corresponding partner instead.
      Two-letter ISO code of the buyers country. This is the country of company which pays the goods. This field is mandatory if no buyer is defined
      Maximum length: 2

    • buyer

      @Deprecated public ECPartnerDTO buyer
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the buyer of the goods. This field is optional. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • ctrySellerIso

      @Deprecated public String ctrySellerIso
      Deprecated.
      As of 2016/05. Use ECPartnerDTO.countryIso of the corresponding partner instead.
      Two-letter ISO code of the sellers country. This is the country of the company who sells the goods. This field is for future use.
      Maximum length: 2

    • seller

      @Deprecated public ECPartnerDTO seller
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the seller of the goods. This field is optional. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • ctryDestinationIso

      @Deprecated public String ctryDestinationIso
      Deprecated.
      As of 2016/05. Use ECPartnerDTO.countryIso of the corresponding partner instead.
      Two-letter ISO code of the destination country. This is the country where the recipient will forward the goods to and the goods are finally used. If empty, it is tried to compute this country. In the current implementation this country is set equal to the recipients country if empty.
      Maximum length: 2

    • finalUser

      @Deprecated public ECPartnerDTO finalUser
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the final user of the goods. The country of the final user is usually the destination country. This field is optional. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • partners

      public ECPartnerDTO[] partners
      Partners involved in this transaction item.
      This array may be used to define partners of the predefined standard roles or partners with other, configured roles.
      If there is at least one partner defined in the array, all other partners that can be defined with the deprecated partners fields in this DTO (like recipient, etc. will be ignored
      Partners of a certain role defined here will replace partners with the same role defined on transaction level. To minimize network traffic, fill the partners on item level only if they differ from the partners on transaction level.
      This field will be ignored for BOM items.

      For IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO) the partners of following partner roles are mandatory: For mandatory partners at least the ECPartnerDTO.countryIso must be filled.
      Since:
      2016/05

    • ctryProductOrigin

      public String ctryProductOrigin
      Two-letter ISO code of the country of origin of the goods.
      This field is for future use.

      Example value: "DE"
      Maximum length: 2

    • decisiveDate

      public Date decisiveDate
      Mandatory field
      The decisive date of the transaction. This date will be used to determine country groups and currency rates (which may be both date dependent).

    • productClassifications

      public ECClassificationDTO[] productClassifications
      The attributes of the transaction item, e.g. export control numbers, material number, commodity code and other relevant numbers for export control checks and license matching.

    • productDataCompletionStatus

      public ECCompletionStatusDTO[] productDataCompletionStatus
      Only relevant when using version 1 for the handling of goods attributes. The completion status indicates whether the product data for DE/EU plug-in and US-EAR plug-in is complete. If there is no completion status object specified for a certain plug-in, it is assumed that the product data of that plug-in is complete.
      Is not supported by IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO).

      When using version 2 for the handling of goods attributes, the completion status can be specified directly via the goods attribute. For not-maintained goods attributes, no classification should be transmitted. To indicate that an item has been classified but is not listed, "NOT_LISTED" should be transmitted.

    • identitiesOfGoods

      public ECIdentityOfGoodsDTO[] identitiesOfGoods
      The identities of goods for this transaction item, e.g. serial numbers, lot numbers, etc.
      To ensure to use the same license for the same physical goods between different transactions (inbound, outbound, etc.), these identities may be used for license matching in addition to the product classifications.
      Since:
      2016/05

    • descriptionOfGoods1

      public String descriptionOfGoods1
      First line of description of commodity

      Example value: "Description 1"
      Maximum length: 40

    • descriptionOfGoods2

      public String descriptionOfGoods2
      Second line of description of commodity

      Example value: "Description 2" Maximum length: 40

    • descriptionOfGoods3

      public String descriptionOfGoods3
      Third line of description of commodity

      Example value: "Description 3"
      Maximum length: 40

    • descriptionOfGoods4

      public String descriptionOfGoods4
      Fourth line of description of commodity

      Example value: "Description 4"
      Maximum length: 40

    • finalUsages

      public String finalUsages
      Indicates the end-uses of the goods. Use FINAL_USAGE_NONE or FINAL_USAGE_ALL to indicates that there is no special end-use or all end-uses are possible. Other special end-uses depend on the plug-ins installed and may be separated by FINAL_USAGES_SEPARATOR if more than one applies.

      Possible values are: This field will be ignored for BOM items.

      Default value: FINAL_USAGE_NONE

    • valueOfGoods

      public ECAmountDTO[] valueOfGoods
      The value of the goods, denoted in different currencies. This is either the invoice price or (if no invoice price is known) the statistical value. When checking for the jurisdiction EU, at least the value in EUR should occur in the array, so value limits of general licenses ("Wertfreigrenzen") can be considered. When checking for the jurisdiction US, at least the value in USD should occur in the array, so value limits of license exceptions can be considered.

    • orderNumber

      public String orderNumber
      Optional field
      Number of the order (contract) or internal file reference that links to the product/check item.

      Example value: "order-121"
      Maximum length: 20

    • quantity

      public BigDecimal quantity
      Optional field
      The quantity in which the product is exported.

      Example value: "12.0"
      Maximum length: 15
      Decimal digits: 3

    • quantityUnit

      public String quantityUnit
      The unit of the quantity. Units must be maintained in the master data of Trade Compliance Management. The unit must contain the ident code of the entry in the master data table. This field is usually optional but becomes mandatory if a quantity is given.

      Example value: "ST"
      Maximum length: 10

    • uniqueClearingIds

      @Deprecated public String[] uniqueClearingIds
      Deprecated.
      As of 2019/05. No longer required due to the new method to check transactions in Export Controls IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO).
      A list of unique approval IDs that release a found restriction or license requirement. ECClearingDTO.uniqueClearingId

    • uniqueParentClearingIds

      @Deprecated public String[] uniqueParentClearingIds
      Deprecated.
      As of 2019/05. No longer required due to the new method to check transactions in Export Controls IExportControl40V2BF.checkTransaction(CheckTransactionRequestDTO). It uses mainApprovalItemTransIdHost and mainApprovalItemIdHost instead.
      A list of unique approval IDs from main approvals which have been already applied. ECClearingDTO.uniqueClearingId

    • jurisdictionFilter

      public ECJurisdictionFilterDTO jurisdictionFilter
      Allows to filter (, i.e., restrict) the jurisdictions to consider for this item; however, only in export control checks. Leave set to null if there is no need to restrict the jurisdictions.
      Since:
      2022/05

    • customData

      public de.aeb.xnsg.foundation.bf.genericdata.GenericDataRecordDTO customData
      Extended generic data for customer specific extension.
      Since:
      2016/05

  • Constructor Details

    • ECItemDTO

      public ECItemDTO()