com.flowable.engage.engine.impl.indexing

Interface ConversationSearchQuery

All Known Implementing Classes:

ConversationSearchQueryImpl

public interface ConversationSearchQuery

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
ConversationSearchQuery	filterId(String filterId) The key of the filter that should be used for doing the query.
com.flowable.platform.common.Page<ConversationSearchResponse>	list(int start, int size) Perform the query with the given paged parameters
ConversationSearchQuery	searchQuery(String query) The full text search query
ConversationSearchQuery	tenantId(String tenantId) Search all conversations for the given tenantId
ConversationSearchQuery	userDefinitionKey(String userDefinitionKey) The user definition key that should be used to lookup the filter.
default ConversationSearchQuery	userId(String userId) Search all conversations for the given user.
ConversationSearchQuery	userIdOrGroups(String userId, Collection<String> userGroups) Search all conversations for the given user or user groups

Method Detail

userId

default ConversationSearchQuery userId(String userId)

Search all conversations for the given user. Searches only conversations where the user is a direct participant (not via a group).

Parameters:

userId - the id of the user

See Also:

userIdOrGroups(String, Collection)

userIdOrGroups

ConversationSearchQuery userIdOrGroups(String userId,
                                       Collection<String> userGroups)

Search all conversations for the given user or user groups

Parameters:

userId - the id of the user

userGroups - the user group ids

tenantId

ConversationSearchQuery tenantId(String tenantId)

Search all conversations for the given tenantId

filterId

ConversationSearchQuery filterId(String filterId)

The key of the filter that should be used for doing the query.

Parameters:

filterId - the filter key

userDefinitionKey

ConversationSearchQuery userDefinitionKey(String userDefinitionKey)

The user definition key that should be used to lookup the filter.

Parameters:

userDefinitionKey - the user definition key where the filter is registered

searchQuery

ConversationSearchQuery searchQuery(String query)

The full text search query

Parameters:

query - the full text seach query

list

com.flowable.platform.common.Page<ConversationSearchResponse> list(int start,
                                                                   int size)

Perform the query with the given paged parameters

Parameters:

start - the start of the query

size - the total number of records that should be returned