Class ECParmsDTO


  • public class ECParmsDTO
    extends Object
    Parameters for the export control checks.
    • Field Detail

      • clientIdentCode

        public String clientIdentCode
        The client to take settings from.

        Example value: "APITEST"
      • profileIdentCode

        public String profileIdentCode
        The ID of the compliance profile to take settings from.

        Example value: "DEFAULT"
      • clientSystemId

        public String clientSystemId
        A unique name of the host system (e.g. Plug-in for SAP® or ASSIST4) sending the request to the business facade for logging purposes.

        Example value: "API-TEST"
      • languages

        public String[] languages
        The constants de or en for the languages of the strings in the result. More than one language is possible.
      • userIdentification

        public String userIdentification
        The user name to be used for logging and for determination of the user's roles.
        It is not required, that this user is a valid user name of the client. However such a user may be granted to have only the role I_EVERYONE.

        Example value: "TESTUSER"
        Maximum length: 100
      • isSuppressedProtocolling

        public Boolean isSuppressedProtocolling
        Defines if the logging should be suppressed for the export control check.
        If true there will be no logging!

        Default value: false, means logging is controlled by profile.
      • isAutoCreateClearings

        public Boolean isAutoCreateClearings
        Defines that the transaction can be automatically approved, if a applicable license is found. If the transaction can be approved automatically, an approval is automatically created per jurisdiction and the transaction is no longer blocked.

        An automatic approval of the transaction is only performed if exactly one suitable license is found with exactly one matching item for one transaction per jurisdiction. Furthermore, an transaction can only be approved automatically if there are no applicable general licenses from the AEB data service.

        This field is only used in calls of IExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO) .
      • isCompareWithClearings

        public Boolean isCompareWithClearings
        If true, any approvals referenced by ECItemDTO.uniqueClearingIds will be compared with the data of the ECItemDTO's passed. If some partner or product classifications differ, the approval can not release an export control result.
        Setting this flag is usually only useful if isAutoUpdateClearings=false and approvals are not automatically updated when transaction data changes. Regardless, setting it will prevent that finalized approvals (which can not be auto-updated) can clear a transaction if the transaction data has meanwhile changed.
        This field is only used in calls of IExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO)

        Default value: false (since this was the implicit behavior before 2016/05)
        Since:
        2016/05
      • todoForMandatoryFields

        @Deprecated
        public Boolean todoForMandatoryFields
        Deprecated.
        As of 2016/05.
        Defines if mandatory fields in an approval should lead to 'Todo' or 'Info' in the ec check result.
        Default value: false, means mandatory fields lead to 'Info' in check result.
      • isAddAddlOptionsAtLicProposal

        public Boolean isAddAddlOptionsAtLicProposal
        Defines that further license options like a blank license or NLR (no license required) should be included in the set of licenses returned by license proposal. These licenses are not suggested.
        A blank license is indicated by licenseId and licenseNumber not specified in ECAvailableLicenseDTO, i.e. is only a template for a not yet specified license. To use this license for the next request at least the license number has to be specified. If the request is IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) the license number references a license maintained in License Management or (if no such license found) a license not maintained in Trade Compliance Management.
        This option is considered for the license proposal of IExportControl40BF.doExportControlChecks(ECTransactionDTO, ECParmsDTO) .

        Default value: true (since this was the implicit behavior before 2016/05)
        Since:
        2016/05
    • Constructor Detail

      • ECParmsDTO

        public ECParmsDTO()