com.flowable.action.api.runtime

Interface ScopedObjectActionFilter

All Known Implementing Classes:

BaseScopedObjectActionFilter, CaseInstanceActionFilter, ProcessInstanceActionFilter

public interface ScopedObjectActionFilter

Author:

Filip Hrisafov, Joram Barrez

Method Summary

Modifier and Type	Method and Description
boolean	acceptsActionDefinition(Object scopedObject, String accessibleByUser, Set<String> userGroupKeys, ActionDefinition actionDefinition, ActionDefinitionModel actionDefinitionModel, ActionInstance actionInstance) Check if the scoped object accepts the provided actionDefinition with the provided actionDefinitionModel.
String	getScopeType() The type of the scope that this filter is responsible for.

Method Detail

getScopeType

String getScopeType()

The type of the scope that this filter is responsible for.

Returns:

the scope type

acceptsActionDefinition

boolean acceptsActionDefinition(Object scopedObject,
                                String accessibleByUser,
                                Set<String> userGroupKeys,
                                ActionDefinition actionDefinition,
                                ActionDefinitionModel actionDefinitionModel,
                                ActionInstance actionInstance)

Check if the scoped object accepts the provided actionDefinition with the provided actionDefinitionModel.

Parameters:

scopedObject - the scoped object (e.g. conversation, user, process, etc) that can be filtered

accessibleByUser - The current user id

userGroupKeys - The groups of the current user

actionDefinition - the action definition that would be returned

actionDefinitionModel - the action definition model for the provided actionDefinition

actionInstance - Optional ActionInstance, if there are action instances related to the scoped object

Returns:

true if the actionDefinition is accepted by the scoped object, false otherwise