Package com.flowable.idm.engine.impl.indexing

Class IdmContactFilterService

java.lang.Object

com.flowable.idm.engine.impl.indexing.IdmContactFilterService

All Implemented Interfaces:

ContactFilterService

public class IdmContactFilterService
extends Object
implements ContactFilterService

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected CoreIdmEngineConfiguration	engineConfiguration

Constructor Summary

Constructors

Constructor	Description
IdmContactFilterService(CoreIdmEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method	Description
ContactSearchQuery	createContactSearchQuery()	Create a query for querying contacts.
List<ContactFilterResponse>	getContactFilters(String userDefinitionKey, String tenantId)	Get all contact filters registered for the given userDefinitionKey in the given tenantId
List<ContactFilterResponse>	getContactFilters(String userDefinitionKey, String tenantId, PlatformUser platformUser)	Get all contact filters registered for the given userDefinitionKey in the given tenantId and are applicable to the given platformUser
void	registerContactFilter(ContactFilter contactFilter)	Registers a new system-wide contact filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

engineConfiguration

protected final CoreIdmEngineConfiguration engineConfiguration

Constructor Detail

IdmContactFilterService

public IdmContactFilterService(CoreIdmEngineConfiguration engineConfiguration)

Method Detail

getContactFilters

public List<ContactFilterResponse> getContactFilters(String userDefinitionKey,
                                                     String tenantId)

Description copied from interface: ContactFilterService

Get all contact filters registered for the given userDefinitionKey in the given tenantId

Specified by:

getContactFilters in interface ContactFilterService

Parameters:

userDefinitionKey - the user definition key in which the contact filters are registered

tenantId - the tenant id

Returns:

Returns all contact filters registered for the user definition

getContactFilters

public List<ContactFilterResponse> getContactFilters(String userDefinitionKey,
                                                     String tenantId,
                                                     PlatformUser platformUser)

Description copied from interface: ContactFilterService

Get all contact filters registered for the given userDefinitionKey in the given tenantId and are applicable to the given platformUser

Specified by:

getContactFilters in interface ContactFilterService

Parameters:

userDefinitionKey - the user definition key in which the contact filters are registered

tenantId - the tenant id

platformUser - the user for which the filters should be applicable

Returns:

all contact filters registered in the user definition and match the user

registerContactFilter

public void registerContactFilter(ContactFilter contactFilter)

Description copied from interface: ContactFilterService

Registers a new system-wide contact filter. The key of the filter needs to be unique.

Specified by:

registerContactFilter in interface ContactFilterService

createContactSearchQuery

public ContactSearchQuery createContactSearchQuery()

Description copied from interface: ContactFilterService

Create a query for querying contacts.

Specified by:

createContactSearchQuery in interface ContactFilterService