Package com.aquima.interactions.matching.request

Interface IAttributeFilter

All Known Implementing Classes:
AttributeFilter
public interface IAttributeFilter
Interface for objects that can determine if an attribute value from the profile should be included in the match request.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Details

    • includeAttribute

      boolean includeAttribute(IEntityInstance instance, IAttributeDefinition attribute)
      This method will be invoked before a value is copied to the match request. This method should return true when the attribute value should be matched, or false when the attribute value should be excluded from the match request.
      Parameters:
      instance - The instance the attribute belongs to.
      attribute - The attribute whose value should be copied.
      Returns:
      Boolean indicating if the value for the specified attribute should be copied to the match request.

    • onException

      void onException(IAttributeDefinition attribute, Exception error)
      This method is invoked when an exception occurs while adding an attribute value to the match request. This method may either ignore the error, usually logging it, or re-throw the exception to indicate the match request could not be created.
      Parameters:
      attribute - The attribute that was being processed when the exception occurred.
      error - The exception that occurred while copying the attribute value.
      Throws:
      AppException - This exception may be thrown by the filter to indicate the match request can not be initialized.