com.flowable.engage.conversation.api.tag

Interface ConversationTagEvaluationContext

All Known Implementing Classes:

AbstractConversationTagEvaluationContext, ConversationBuilderBasedTagEvaluationContext, ConversationEntityBasedTagEvaluationContext

public interface ConversationTagEvaluationContext

The tag evaluation context might be used within a ConversationTagProvider to request additional information in order to evaluate tags for conversations. The context might cache data to improve lookup.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
void	addTag(String tag) Adds the provided tag to the list of tags for the conversation being evaluated for tags.
String	getConversationJoiningType() Returns the joining type of the conversation which defines on how new participants might join the running conversation.
String	getConversationName() Returns the name of the conversation being evaluated for tags.
String	getConversationPermissionType() Returns the permission type for the conversation which is used to drive the permissions for messages and events sent to this conversation.
String	getConversationSubType() Returns the sub type of the conversation being evaluated for tags.
String	getConversationType() Returns the type of the conversation being evaluated for tags.
Set<String>	getCurrentTags() Returns the set of the currently assigned tags from previous providers or the current provider.
Set<String>	getFilteredTags(String tagPrefix) Returns a filtered set of existing tags with a specific prefix.
Set<String>	getOldTags() Returns the previously evaluated tags (existing tags) for this conversation, if isNewConversation() is true, this method will return null.
Collection<String>	getParticipants(boolean includeUserBasedParticipants, boolean includeGroupBasedParticipants) Returns the participants of the conversation, optionally including directly assigned users or indirectly assigned users over member groups.
boolean	hasTag(String tag) Returns true if the specified tag has been added already.
boolean	isNewConversation() Returns true if this is a newly initialized conversation and this is the first time its tags are evaluated.
void	removeTag(String tag) A tag provider might also remove tags which have been added by providers beforehand.

Method Detail

getConversationType

String getConversationType()

Returns the type of the conversation being evaluated for tags.

Returns:

the type of the conversation

getConversationSubType

String getConversationSubType()

Returns the sub type of the conversation being evaluated for tags.

Returns:

the sub type of the conversation

getConversationName

String getConversationName()

Returns the name of the conversation being evaluated for tags.

Returns:

the name of the conversation

getConversationPermissionType

String getConversationPermissionType()

Returns the permission type for the conversation which is used to drive the permissions for messages and events sent to this conversation.

Returns:

the permission type for the conversation

getConversationJoiningType

String getConversationJoiningType()

Returns the joining type of the conversation which defines on how new participants might join the running conversation.

Returns:

the joining type of the conversation

getParticipants

Collection<String> getParticipants(boolean includeUserBasedParticipants,
                                   boolean includeGroupBasedParticipants)

Returns the participants of the conversation, optionally including directly assigned users or indirectly assigned users over member groups.

Parameters:

includeUserBasedParticipants - true if all directly assigned users should be returned as well

includeGroupBasedParticipants - true if all group members of the assigned groups of the conversation should be resolved as well

Returns:

the collection of user ids

isNewConversation

boolean isNewConversation()

Returns true if this is a newly initialized conversation and this is the first time its tags are evaluated. Obviously getOldTags() will return null.

Returns:

true for a new conversation, false when invoked to update a conversation

getOldTags

Set<String> getOldTags()

Returns the previously evaluated tags (existing tags) for this conversation, if isNewConversation() is true, this method will return null.

Returns:

the old tags, if this is an existing conversation or an empty set for an existing conversation, if it does not have tags, null only, if this is a new conversation

getCurrentTags

Set<String> getCurrentTags()

Returns the set of the currently assigned tags from previous providers or the current provider.

Returns:

the currently attached tags, if any, otherwise an empty set is returned, but never null

hasTag

boolean hasTag(String tag)

Returns true if the specified tag has been added already.

Parameters:

tag - the tag to check

Returns:

true if the tag exists, false otherwise

getFilteredTags

Set<String> getFilteredTags(String tagPrefix)

Returns a filtered set of existing tags with a specific prefix.

Parameters:

tagPrefix - the prefix to filter the existing tags for

Returns:

the filtered set, might be empty, but never null

addTag

void addTag(String tag)

Adds the provided tag to the list of tags for the conversation being evaluated for tags. Make sure the tags being added are prefixed with ConversationTagProvider.EVALUATED_TAGS_PREFIX otherwise this method will throw an exception.

Parameters:

tag - the tag to be added

removeTag

void removeTag(String tag)

A tag provider might also remove tags which have been added by providers beforehand.

Parameters:

tag - the tag to be removed