Interface IRexBF


  • @BusinessFacade
    public interface IRexBF
    The interface to the address pool which is able to search for addresses in restricted party lists by heuristic matching and to define Good Guys.
    • Method Detail

      • getMatchingAddresses

        AddressMatchDTO[] getMatchingAddresses​(AddressPatternDTO pattern,
                                               MatchParametersDTO parms)
        Finds matching addresses for one specific AddressPatternDTO. If a match is found, this is logged in Trade Compliance Management, unless the flag "suppressLogging" is set in the parameters.

        Returns only the matching addresses, no additional information about the match (i.e. if a Good Guy was found).

        Parameters:
        pattern - The address to search for.
        parms - Parameters for the address pool.
        Returns:
        The restricted party list addresses matching the given address.
      • batchMatch

        BatchMatchResultDTO[] batchMatch​(AddressPatternDTO[] patterns,
                                         MatchParametersDTO parms)
        Batch mode for address matching, which allows the check of multiple addresses at once. The returned array indicates whether at least one possible match has been found. If a match has been found, this is logged in Trade Compliance Management, unless the flag "suppressLogging" is set in the parameters.

        Returns only if matches were found or not and additional information like if a Good Guy was found.

        Parameters:
        patterns - The addresses to search for.
        parms - Parameters for the address pool.
        Returns:
        An array of BatchMatchResultDTO.
      • getAliasAddresses

        AddressMatchDTO[] getAliasAddresses​(AddressMatchDTO sourceAddress)
        Returns all known alias addresses for the sourceAddress. If the sourceAddress is created manually the following fields have to be filled correctly to get a result.
        • internalAddressId
        • listName
        • aliasGroupNo
        If the source address is a completely filled AddressMatchDTO, or the sourceAddress can be identified in the result list via the internalAddressId the sourceAddress will NOT be part of the result.
        Parameters:
        sourceAddress - is the address for which the alias addresses should be looked up
        Returns:
        the known alias addresses
      • defineGoodGuyWithResult

        GoodGuyDefinitionResultDTO defineGoodGuyWithResult​(GoodGuyAddressDTO goodGuy)
        Adds the passed address to all Good Guy lists. Good Guys will never be defined twice, i.e. if the same Good Guy already exists, he will not be defined again on any other Good Guy list. This is also true for not active Good Guys, which will not become active by using this method.
        Parameters:
        goodGuy - The Good Guy to be defined as a member of all Good Guy lists contained in the corresponding compliance profile.
        Returns:
        Returns detailed information about the Good Guy definition.
      • protocolClientSystemEvent

        void protocolClientSystemEvent​(ClientSystemComplianceEventDTO event)
        Logs a generic event from the client system in Trade Compliance Management.
        Parameters:
        event - the event to log
      • getAllProfilesForClient

        ProfileDTO[] getAllProfilesForClient​(String clientIdentCode)
        Returns all profiles for the given client.
        Parameters:
        clientIdentCode - a valid client identifier
        Returns:
        All compliance profiles for the given client
      • getLastTerrorListUpdate

        Date getLastTerrorListUpdate​(String client,
                                     String profile)
        Returns the last date of a terror list update for the given client and profile.
        Parameters:
        client - a valid client identifier
        profile - a valid compliance profile
        Returns:
        The Date of last terror list update