Interface ContactFilterService
- All Known Implementing Classes:
ContactFilterServiceImpl
,IdmContactFilterService
public interface ContactFilterService
-
Method Summary
Modifier and TypeMethodDescriptionCreate a query for querying contacts.getContactFilters
(String userDefinitionKey, String tenantId) Get all contact filters registered for the givenuserDefinitionKey
in the giventenantId
getContactFilters
(String userDefinitionKey, String tenantId, PlatformUser platformUser) Get all contact filters registered for the givenuserDefinitionKey
in the giventenantId
and are applicable to the givenplatformUser
void
registerContactFilter
(ContactFilter contactFilter) Registers a new system-wide contact filter.
-
Method Details
-
getContactFilters
Get all contact filters registered for the givenuserDefinitionKey
in the giventenantId
- Parameters:
userDefinitionKey
- the user definition key in which the contact filters are registeredtenantId
- the tenant id- Returns:
- Returns all contact filters registered for the user definition
-
getContactFilters
List<ContactFilterResponse> getContactFilters(String userDefinitionKey, String tenantId, PlatformUser platformUser) Get all contact filters registered for the givenuserDefinitionKey
in the giventenantId
and are applicable to the givenplatformUser
- Parameters:
userDefinitionKey
- the user definition key in which the contact filters are registeredtenantId
- the tenant idplatformUser
- the user for which the filters should be applicable- Returns:
- all contact filters registered in the user definition and match the user
-
registerContactFilter
Registers a new system-wide contact filter. The key of the filter needs to be unique. -
createContactSearchQuery
ContactSearchQuery createContactSearchQuery()Create a query for querying contacts.
-