Package com.flowable.action.api.repository

Interface ActionDefinitionModel

All Known Implementing Classes:
BaseActionDefinitionModel
public interface ActionDefinitionModel
An action definition model contains all information around an action definition, its necessary permissions and mapped types and many things more to have pluggable actions on scoped objects like conversations, users, etc.
Author:
Micha Kiener, Filip Hrisafov

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String CONFIRMATION_MESSAGE_DEFINITION_KEY
    The template definition key used for using the template engine when rendering confirmation messages and using the code as the variation.
    static java.lang.String CONFIRMATION_TITLE_DEFINITION_KEY
    The template definition key used for using the template engine when rendering confirmation titles and using the code as the variation.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getBotKey()  
    java.util.List<java.lang.String> getChannels()  
    java.lang.String getConfirmationMessage()
    As an alternative to a modeled form, a simple confirmation message might be provided by the action definition.
    java.lang.String getConfirmationMessageCode()
    As an alternative to a modeled form or fixed confirmation message, you can also specify a confirmation code to be used with the template engine to render.
    java.lang.String getConfirmationTitle()
    As an optional addition to the confirmation message (also see comments there), you can specify the title for the confirmation dialog, if the default is not sufficient.
    java.lang.String getConfirmationTitleCode()
    Instead of the optional confirmation title, you can also specify a confirmation title code to use the template engine for the title of the confirmation dialog.
    java.lang.String getDescription()  
    java.lang.String getFormKey()  
    java.lang.Boolean getGlobal()  
    java.lang.String getGroupId()  
    java.lang.String getHelp()
    Returns the more extended description or help for the action, which is optional and might describe more details about the action, its purpose and parameters.
    java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> getI18n()  
    java.lang.String getIcon()  
    java.lang.Boolean getIgnoreConfirmationMessage()  
    java.lang.String getKey()  
    java.util.List<java.lang.String> getMappedStates()  
    java.util.List<java.lang.String> getMappedSubStates()  
    java.util.List<java.lang.String> getMappedSubTypes()  
    java.util.List<java.lang.String> getMappedTypes()  
    java.lang.String getName()  
    java.util.List<java.lang.String> getPermissionGroups()
    The permissions groups that have permission to see the action.
    java.util.Set<java.lang.String> getPermissionUserIdentityLinkTypes()
    The types of user identity links that have permission to see the action.
    java.lang.Integer getPriority()  
    java.lang.String getSample()
    Returns the optional sample of how this action could look like as an extension to the description.
    java.lang.String getScopeType()  
    java.lang.String getSignalName()  
    java.util.List<java.lang.String> getSignalVariableNames()  
    java.lang.String getTheme()  
    boolean isFormSameDeployment()  

  • Field Details

  • Method Details

    • getKey

      java.lang.String getKey()

    • getName

      java.lang.String getName()

    • getDescription

      java.lang.String getDescription()

    • getFormKey

      java.lang.String getFormKey()

    • isFormSameDeployment

      boolean isFormSameDeployment()

    • getScopeType

      java.lang.String getScopeType()

    • getPermissionUserIdentityLinkTypes

      java.util.Set<java.lang.String> getPermissionUserIdentityLinkTypes()
      The types of user identity links that have permission to see the action. This is combined with getPermissionGroups() when checking for permissions. If a user is not a member of the getPermissionGroups(), but has an identity link type within this list, then the user will have access to the action.
      Returns:
      the types of user identity links

    • getPermissionGroups

      java.util.List<java.lang.String> getPermissionGroups()
      The permissions groups that have permission to see the action. This is combined with getPermissionUserIdentityLinkTypes() when checking for permissions. If a user is not a member of the permissions groups, but has an identity link type part of getPermissionUserIdentityLinkTypes(), then the user will have access to the action.
      Returns:
      the list of permission groups

    • getMappedTypes

      java.util.List<java.lang.String> getMappedTypes()

    • getMappedSubTypes

      java.util.List<java.lang.String> getMappedSubTypes()

    • getMappedStates

      java.util.List<java.lang.String> getMappedStates()

    • getMappedSubStates

      java.util.List<java.lang.String> getMappedSubStates()

    • getChannels

      java.util.List<java.lang.String> getChannels()

    • getTheme

      java.lang.String getTheme()

    • getIcon

      java.lang.String getIcon()

    • getPriority

      java.lang.Integer getPriority()

    • getGroupId

      java.lang.String getGroupId()

    • getSample

      java.lang.String getSample()
      Returns the optional sample of how this action could look like as an extension to the description.
      Returns:
      the optional sample for this action with sample parameter values

    • getHelp

      java.lang.String getHelp()
      Returns the more extended description or help for the action, which is optional and might describe more details about the action, its purpose and parameters.
      Returns:
      the optional help description for the action

    • getConfirmationMessage

      java.lang.String getConfirmationMessage()
      As an alternative to a modeled form, a simple confirmation message might be provided by the action definition. If available, the provided message is shown to get confirmation from the user to execute the action definition. As an alternative to a fixed confirmation message, you can also specify a confirmation message code which will then be used with the template engine to render and you can use placeholders using the scoped object to make it dynamic.
      Returns:
      the optional confirmation message as an alternative to a modeled form

    • getConfirmationMessageCode

      java.lang.String getConfirmationMessageCode()
      As an alternative to a modeled form or fixed confirmation message, you can also specify a confirmation code to be used with the template engine to render. And it might use the scoped objects data within placeholders to make it dynamic. The template definition key is fixed in this case and is CONFIRMATION_MESSAGE_DEFINITION_KEY and the returned code is considered the variation for the template.
      Returns:
      the optional confirmation message code if the template engine should be used to render the confirmation message for this action definition

    • getConfirmationTitle

      java.lang.String getConfirmationTitle()
      As an optional addition to the confirmation message (also see comments there), you can specify the title for the confirmation dialog, if the default is not sufficient.
      Returns:
      the optional confirmation dialog title, if the default should be overwritten

    • getConfirmationTitleCode

      java.lang.String getConfirmationTitleCode()
      Instead of the optional confirmation title, you can also specify a confirmation title code to use the template engine for the title of the confirmation dialog.
      Returns:
      the optional confirmation dialog title code to be used with the template engine

    • getIgnoreConfirmationMessage

      java.lang.Boolean getIgnoreConfirmationMessage()

    • getGlobal

      java.lang.Boolean getGlobal()

    • getBotKey

      java.lang.String getBotKey()

    • getSignalName

      java.lang.String getSignalName()

    • getSignalVariableNames

      java.util.List<java.lang.String> getSignalVariableNames()

    • getI18n

      java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> getI18n()