Package de.aeb.xnsg.rex.bf

Class MatchParametersDTO

java.lang.Object
de.aeb.xnsg.rex.bf.MatchParametersDTO
All Implemented Interfaces:
Serializable
public class MatchParametersDTO extends Object implements Serializable
Data transfer object of parameters for a screening match request.
See Also:

  • Field Details

    • CHECK_TYPE_MANUAL

      public static final String CHECK_TYPE_MANUAL
      Internal use only. Allowed value for the field checkType.
      See Also:

    • CHECK_TYPE_FILE

      public static final String CHECK_TYPE_FILE
      Internal use only. Allowed value for the field checkType.
      See Also:

    • CHECK_TYPE_GGSCREENING

      public static final String CHECK_TYPE_GGSCREENING
      Internal use only. Allowed value for the field checkType.
      See Also:

    • ADDRESS_TYPE_VERSION_0

      public static final String ADDRESS_TYPE_VERSION_0
      Allowed value for the field addressTypeVersion.
      Since:
      2019/11
      See Also:

    • ADDRESS_TYPE_VERSION_1

      public static final String ADDRESS_TYPE_VERSION_1
      Allowed value for the field addressTypeVersion.
      Since:
      2019/11
      See Also:

    • clientIdentCode

      public String clientIdentCode
      Ident code of the client in Trade Compliance Management. The value must be a valid ident code of a client customized in Trade Compliance Management. The clientIdentCode and the profileIdentCode specify parameters of the called web service method.
      This field must be filled, otherwise an exception will be thrown.
      Max. Length: 10.

    • profileIdentCode

      public String profileIdentCode
      Ident code of a Compliance profile. The value must be a valid ident code of a profile customized in Trade Compliance Management and must belong to the client specified by the clientIdentCode. The clientIdentCode and the profileIdentCode specify parameters of the called web service method.
      This field must be filled, otherwise an exception will be thrown.
      Max. Length: 20.

    • threshold

      public Integer threshold
      Define the similarity threshold in percentage which should be used for screening checks.
      Optionally overrides the value from the Compliance profile used.
      In most cases, this value should be left empty.
      When no value is submitted or the submitted value equals zero, the value from the Compliance profile will be used.
      Valid values are: 1 to 100.
      It is recommended to choose a value between 75 and 85.
      Values below this range can have negative effects on performance and on the result quality.
      Max. Length: 3.

    • addressTranslateThreshold

      public Integer addressTranslateThreshold
      Defines an optional similarity threshold in percentage which should be used for screening checks that were translated.
      This value is only used if the translation feature is enabled for the profile.
      This value overrides the value from the used compliance profile.
      When no value is submitted or the submitted value equals zero, the value from the Compliance profile will be used.
      Valid values are: 1 to 100.
      It is recommended to choose a value between 75 and 85.
      Values below this range can have negative effects on performance and on the result quality.
      Max. Length: 3.
      Since:
      2020/10

    • addrMatchWithoutNameThreshold

      public Integer addrMatchWithoutNameThreshold
      Defines an optional similarity threshold in percentage which should be used for screening checks without name.
      This value overrides the value from the used compliance profile.
      When no value is submitted or the submitted value equals zero, the value from the Compliance profile will be used.
      Valid values are: 1 to 100.
      It is recommended to choose a value between 75 and 85.
      Values below this range can have negative effects on performance and on the result quality.
      Max. Length: 3.
      Since:
      2020/10

    • clientSystemId

      public String clientSystemId
      The unique id of the calling system used for logging.
      The ASSIST4 host system should use a value like "AS4" and the Plug-in for SAP® a value like "SAP_[SAP system]_[SAP client]".
      Max. Length: 20.

    • organisationUnitHost

      public String organisationUnitHost
      Ident code of the organizational unit, e.g., ""Sales Unit 0711". May be null. Currently not used. Functionality will be added at a later date.
      Max. Length: 255
      Since:
      2024/01

    • suppressLogging

      public boolean suppressLogging
      If true, the address screening operation will not be logged, thus match handling in Trade Compliance Management will not be possible.
      If omitted or false, the address screening operation will be logged.

    • considerGoodGuys

      public boolean considerGoodGuys
      If true content of goodGuyListNames or good guy list names of given profile will be considered in address check, if false the good guy lists will be ignored. Default value is true. This switch is especially useful to check good guys themselves, as if they were NOT defined as good guys.

    • userIdentification

      public String userIdentification
      The user name to be used for logging. Purely informational.

      Max. Length: 100

    • checkType

      public String checkType
      Internal use only. Leave this field empty when implementing the webservice.
      See Also:

    • addressTypeVersion

      public String addressTypeVersion
      The addressTypeVersion defines the result behavior of AddressDTO.addressType when calling IRexBF.getMatchingAddresses(AddressPatternDTO, MatchParametersDTO).
      Possible values are ADDRESS_TYPE_VERSION_0 or ADDRESS_TYPE_VERSION_1 and the default is ADDRESS_TYPE_VERSION_0.
      ADDRESS_TYPE_VERSION_0 means the possible return values of AddressDTO.addressType are AddressDTO.ADDRESS_TYPE_COMPANY, AddressDTO.ADDRESS_TYPE_INDIVIDUAL, AddressDTO.ADDRESS_TYPE_BANK and AddressDTO.ADDRESS_TYPE_VESSEL.
      ADDRESS_TYPE_VERSION_1 means the possible return values of AddressDTO.addressType are AddressDTO.ADDRESS_TYPE_ENTITY, AddressDTO.ADDRESS_TYPE_INDIVIDUAL, AddressDTO.ADDRESS_TYPE_MEANS_OF_TRANSPORT and AddressDTO.ADDRESS_TYPE_UNKNOWN.
      Since:
      2019/11

  • Constructor Details

    • MatchParametersDTO

      public MatchParametersDTO()