java.lang.Object
- com.flowable.action.api.repository.BaseActionDefinitionModel

All Implemented Interfaces:: ActionDefinitionModel

public class BaseActionDefinitionModel
extends Object
implements ActionDefinitionModel

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`botKey`
`protected List<String>`	`channels`
`protected com.fasterxml.jackson.databind.JsonNode`	`config`
`protected String`	`confirmationMessage`
`protected String`	`confirmationMessageCode`
`protected String`	`confirmationTitle`
`protected String`	`confirmationTitleCode`
`protected String`	`description`
`protected String`	`formKey`
`protected boolean`	`formSameDeployment`
`protected Boolean`	`global`
`protected String`	`groupId`
`protected String`	`help`
`protected Map<String,Map<String,String>>`	`i18n`
`protected String`	`icon`
`protected Boolean`	`ignoreConfirmationMessage`
`protected String`	`key`
`protected List<String>`	`mappedStates`
`protected List<String>`	`mappedSubStates`
`protected List<String>`	`mappedSubTypes`
`protected List<String>`	`mappedTypes`
`protected String`	`name`
`protected List<String>`	`permissionGroups`
`protected Set<String>`	`permissionUserIdentityLinkTypes`
`protected Integer`	`priority`
`protected String`	`sample`
`protected String`	`scopeType`
`protected String`	`signalName`
`protected List<String>`	`signalVariableNames`
`protected String`	`theme`

Fields inherited from interface com.flowable.action.api.repository.ActionDefinitionModel
CONFIRMATION_MESSAGE_DEFINITION_KEY, CONFIRMATION_TITLE_DEFINITION_KEY

Constructor Summary

Constructors
Constructor Description

BaseActionDefinitionModel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getBotKey()`
`List<String>`	`getChannels()`
`com.fasterxml.jackson.databind.JsonNode`	`getConfig()`	Optional configuration parameters for the action.
`String`	`getConfirmationMessage()`	As an alternative to a modeled form, a simple confirmation message might be provided by the action definition.
`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.
`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.
`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.
`String`	`getDescription()`
`String`	`getFormKey()`
`Boolean`	`getGlobal()`
`String`	`getGroupId()`
`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.
`Map<String,Map<String,String>>`	`getI18n()`
`String`	`getIcon()`
`Boolean`	`getIgnoreConfirmationMessage()`
`String`	`getKey()`
`List<String>`	`getMappedStates()`
`List<String>`	`getMappedSubStates()`
`List<String>`	`getMappedSubTypes()`
`List<String>`	`getMappedTypes()`
`String`	`getName()`
`List<String>`	`getPermissionGroups()`	The permissions groups that have permission to see the action.
`Set<String>`	`getPermissionUserIdentityLinkTypes()`	The types of user identity links that have permission to see the action.
`Integer`	`getPriority()`
`String`	`getSample()`	Returns the optional sample of how this action could look like as an extension to the description.
`String`	`getScopeType()`
`String`	`getSignalName()`
`List<String>`	`getSignalVariableNames()`
`String`	`getTheme()`
`boolean`	`isFormSameDeployment()`
`void`	`setBotKey(String botKey)`
`void`	`setChannels(List<String> channels)`
`void`	`setConfig(com.fasterxml.jackson.databind.JsonNode config)`
`void`	`setConfirmationMessage(String confirmationMessage)`
`void`	`setConfirmationMessageCode(String confirmationMessageCode)`
`void`	`setConfirmationTitle(String confirmationTitle)`
`void`	`setConfirmationTitleCode(String confirmationTitleCode)`
`void`	`setDescription(String description)`
`void`	`setFormKey(String formKey)`
`void`	`setFormSameDeployment(boolean formSameDeployment)`
`void`	`setGlobal(Boolean global)`
`void`	`setGroupId(String groupId)`
`void`	`setHelp(String help)`
`void`	`setI18n(Map<String,Map<String,String>> i18n)`
`void`	`setIcon(String icon)`
`void`	`setIgnoreConfirmationMessage(Boolean ignoreConfirmationMessage)`
`void`	`setKey(String key)`
`void`	`setMappedStates(List<String> mappedStates)`
`void`	`setMappedSubStates(List<String> mappedSubStates)`
`void`	`setMappedSubTypes(List<String> mappedSubTypes)`
`void`	`setMappedTypes(List<String> mappedTypes)`
`void`	`setName(String name)`
`void`	`setPermissionGroups(List<String> permissionGroups)`
`void`	`setPermissionUserIdentityLinkTypes(Set<String> permissionUserIdentityLinkTypes)`
`void`	`setPriority(Integer priority)`
`void`	`setSample(String sample)`
`void`	`setScopeType(String scopeType)`
`void`	`setSignalName(String signalName)`
`void`	`setSignalVariableNames(List<String> signalVariableNames)`
`void`	`setTheme(String theme)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - key
```
protected String key
```
  - name
```
protected String name
```
  - description
```
protected String description
```
  - formKey
```
protected String formKey
```
  - formSameDeployment
```
protected boolean formSameDeployment
```
  - confirmationMessage
```
protected String confirmationMessage
```
  - confirmationMessageCode
```
protected String confirmationMessageCode
```
  - confirmationTitle
```
protected String confirmationTitle
```
  - confirmationTitleCode
```
protected String confirmationTitleCode
```
  - ignoreConfirmationMessage
```
protected Boolean ignoreConfirmationMessage
```
  - scopeType
```
protected String scopeType
```
  - permissionUserIdentityLinkTypes
```
protected Set<String> permissionUserIdentityLinkTypes
```
  - permissionGroups
```
protected List<String> permissionGroups
```
  - mappedStates
```
protected List<String> mappedStates
```
  - mappedSubStates
```
protected List<String> mappedSubStates
```
  - mappedTypes
```
protected List<String> mappedTypes
```
  - mappedSubTypes
```
protected List<String> mappedSubTypes
```
  - channels
```
protected List<String> channels
```
  - theme
```
protected String theme
```
  - icon
```
protected String icon
```
  - priority
```
protected Integer priority
```
  - groupId
```
protected String groupId
```
  - sample
```
protected String sample
```
  - help
```
protected String help
```
  - global
```
protected Boolean global
```
  - botKey
```
protected String botKey
```
  - signalName
```
protected String signalName
```
  - signalVariableNames
```
protected List<String> signalVariableNames
```
  - i18n
```
protected Map<String,Map<String,String>> i18n
```
  - config
```
protected com.fasterxml.jackson.databind.JsonNode config
```
- Constructor Detail
  - BaseActionDefinitionModel
```
public BaseActionDefinitionModel()
```
- Method Detail
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface ActionDefinitionModel
  - setKey
```
public void setKey(String key)
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ActionDefinitionModel
  - setName
```
public void setName(String name)
```
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface ActionDefinitionModel
  - setDescription
```
public void setDescription(String description)
```
  - getFormKey
```
public String getFormKey()
```
    Specified by:
    
    getFormKey in interface ActionDefinitionModel
  - setFormKey
```
public void setFormKey(String formKey)
```
  - isFormSameDeployment
```
public boolean isFormSameDeployment()
```
    Specified by:
    
    isFormSameDeployment in interface ActionDefinitionModel
  - setFormSameDeployment
```
public void setFormSameDeployment(boolean formSameDeployment)
```
  - getConfirmationMessage
```
public String getConfirmationMessage()
```
    Description copied from interface: ActionDefinitionModel
    
    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.
    
    Specified by:
    
    getConfirmationMessage in interface ActionDefinitionModel
    
    Returns:
    
    the optional confirmation message as an alternative to a modeled form
  - setConfirmationMessage
```
public void setConfirmationMessage(String confirmationMessage)
```
  - getConfirmationMessageCode
```
public String getConfirmationMessageCode()
```
    Description copied from interface: ActionDefinitionModel
    
    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 ActionDefinitionModel.CONFIRMATION_MESSAGE_DEFINITION_KEY and the returned code is considered the variation for the template.
    
    Specified by:
    
    getConfirmationMessageCode in interface ActionDefinitionModel
    
    Returns:
    
    the optional confirmation message code if the template engine should be used to render the confirmation message for this action definition
  - setConfirmationMessageCode
```
public void setConfirmationMessageCode(String confirmationMessageCode)
```
  - getConfirmationTitle
```
public String getConfirmationTitle()
```
    Description copied from interface: ActionDefinitionModel
    
    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.
    
    Specified by:
    
    getConfirmationTitle in interface ActionDefinitionModel
    
    Returns:
    
    the optional confirmation dialog title, if the default should be overwritten
  - setConfirmationTitle
```
public void setConfirmationTitle(String confirmationTitle)
```
  - getConfirmationTitleCode
```
public String getConfirmationTitleCode()
```
    Description copied from interface: ActionDefinitionModel
    
    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.
    
    Specified by:
    
    getConfirmationTitleCode in interface ActionDefinitionModel
    
    Returns:
    
    the optional confirmation dialog title code to be used with the template engine
  - setConfirmationTitleCode
```
public void setConfirmationTitleCode(String confirmationTitleCode)
```
  - getIgnoreConfirmationMessage
```
public Boolean getIgnoreConfirmationMessage()
```
    Specified by:
    
    getIgnoreConfirmationMessage in interface ActionDefinitionModel
  - setIgnoreConfirmationMessage
```
public void setIgnoreConfirmationMessage(Boolean ignoreConfirmationMessage)
```
  - getScopeType
```
public String getScopeType()
```
    Specified by:
    
    getScopeType in interface ActionDefinitionModel
  - setScopeType
```
public void setScopeType(String scopeType)
```
  - getPermissionUserIdentityLinkTypes
```
public Set<String> getPermissionUserIdentityLinkTypes()
```
    Description copied from interface: ActionDefinitionModel
    
    The types of user identity links that have permission to see the action. This is combined with ActionDefinitionModel.getPermissionGroups() when checking for permissions. If a user is not a member of the ActionDefinitionModel.getPermissionGroups(), but has an identity link type within this list, then the user will have access to the action.
    
    Specified by:
    
    getPermissionUserIdentityLinkTypes in interface ActionDefinitionModel
    
    Returns:
    
    the types of user identity links
  - setPermissionUserIdentityLinkTypes
```
public void setPermissionUserIdentityLinkTypes(Set<String> permissionUserIdentityLinkTypes)
```
  - getPermissionGroups
```
public List<String> getPermissionGroups()
```
    Description copied from interface: ActionDefinitionModel
    
    The permissions groups that have permission to see the action. This is combined with ActionDefinitionModel.getPermissionUserIdentityLinkTypes() when checking for permissions. If a user is not a member of the permissions groups, but has an identity link type part of ActionDefinitionModel.getPermissionUserIdentityLinkTypes(), then the user will have access to the action.
    
    Specified by:
    
    getPermissionGroups in interface ActionDefinitionModel
    
    Returns:
    
    the list of permission groups
  - setPermissionGroups
```
public void setPermissionGroups(List<String> permissionGroups)
```
  - getMappedStates
```
public List<String> getMappedStates()
```
    Specified by:
    
    getMappedStates in interface ActionDefinitionModel
  - setMappedStates
```
public void setMappedStates(List<String> mappedStates)
```
  - getMappedSubStates
```
public List<String> getMappedSubStates()
```
    Specified by:
    
    getMappedSubStates in interface ActionDefinitionModel
  - setMappedSubStates
```
public void setMappedSubStates(List<String> mappedSubStates)
```
  - getMappedTypes
```
public List<String> getMappedTypes()
```
    Specified by:
    
    getMappedTypes in interface ActionDefinitionModel
  - setMappedTypes
```
public void setMappedTypes(List<String> mappedTypes)
```
  - getMappedSubTypes
```
public List<String> getMappedSubTypes()
```
    Specified by:
    
    getMappedSubTypes in interface ActionDefinitionModel
  - setMappedSubTypes
```
public void setMappedSubTypes(List<String> mappedSubTypes)
```
  - getChannels
```
public List<String> getChannels()
```
    Specified by:
    
    getChannels in interface ActionDefinitionModel
  - setChannels
```
public void setChannels(List<String> channels)
```
  - getTheme
```
public String getTheme()
```
    Specified by:
    
    getTheme in interface ActionDefinitionModel
  - setTheme
```
public void setTheme(String theme)
```
  - getIcon
```
public String getIcon()
```
    Specified by:
    
    getIcon in interface ActionDefinitionModel
  - setIcon
```
public void setIcon(String icon)
```
  - getPriority
```
public Integer getPriority()
```
    Specified by:
    
    getPriority in interface ActionDefinitionModel
  - setPriority
```
public void setPriority(Integer priority)
```
  - getGroupId
```
public String getGroupId()
```
    Specified by:
    
    getGroupId in interface ActionDefinitionModel
  - setGroupId
```
public void setGroupId(String groupId)
```
  - getSample
```
public String getSample()
```
    Description copied from interface: ActionDefinitionModel
    
    Returns the optional sample of how this action could look like as an extension to the description.
    
    Specified by:
    
    getSample in interface ActionDefinitionModel
    
    Returns:
    
    the optional sample for this action with sample parameter values
  - setSample
```
public void setSample(String sample)
```
  - getHelp
```
public String getHelp()
```
    Description copied from interface: ActionDefinitionModel
    
    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.
    
    Specified by:
    
    getHelp in interface ActionDefinitionModel
    
    Returns:
    
    the optional help description for the action
  - setHelp
```
public void setHelp(String help)
```
  - getGlobal
```
public Boolean getGlobal()
```
    Specified by:
    
    getGlobal in interface ActionDefinitionModel
  - setGlobal
```
public void setGlobal(Boolean global)
```
  - getBotKey
```
public String getBotKey()
```
    Specified by:
    
    getBotKey in interface ActionDefinitionModel
  - setBotKey
```
public void setBotKey(String botKey)
```
  - getSignalName
```
public String getSignalName()
```
    Specified by:
    
    getSignalName in interface ActionDefinitionModel
  - setSignalName
```
public void setSignalName(String signalName)
```
  - getSignalVariableNames
```
public List<String> getSignalVariableNames()
```
    Specified by:
    
    getSignalVariableNames in interface ActionDefinitionModel
  - setSignalVariableNames
```
public void setSignalVariableNames(List<String> signalVariableNames)
```
  - getI18n
```
public Map<String,Map<String,String>> getI18n()
```
    Specified by:
    
    getI18n in interface ActionDefinitionModel
  - setI18n
```
public void setI18n(Map<String,Map<String,String>> i18n)
```
  - getConfig
```
public com.fasterxml.jackson.databind.JsonNode getConfig()
```
    Description copied from interface: ActionDefinitionModel
    
    Optional configuration parameters for the action. Allows to add action/bot implementation specific configurations.
    
    Specified by:
    
    getConfig in interface ActionDefinitionModel
  - setConfig
```
public void setConfig(com.fasterxml.jackson.databind.JsonNode config)
```

Class BaseActionDefinitionModel

Field Summary

Fields inherited from interface com.flowable.action.api.repository.ActionDefinitionModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

key

name

description

formKey

formSameDeployment

confirmationMessage

confirmationMessageCode

confirmationTitle

confirmationTitleCode

ignoreConfirmationMessage

scopeType

permissionUserIdentityLinkTypes

permissionGroups

mappedStates

mappedSubStates

mappedTypes

mappedSubTypes

channels

theme

icon

priority

groupId

sample

help

global

botKey

signalName

signalVariableNames

i18n

config

Constructor Detail

BaseActionDefinitionModel

Method Detail

getKey

setKey

getName

setName

getDescription

setDescription

getFormKey

setFormKey

isFormSameDeployment

setFormSameDeployment

getConfirmationMessage

setConfirmationMessage

getConfirmationMessageCode

setConfirmationMessageCode

getConfirmationTitle

setConfirmationTitle

getConfirmationTitleCode

setConfirmationTitleCode

getIgnoreConfirmationMessage

setIgnoreConfirmationMessage

getScopeType

setScopeType

getPermissionUserIdentityLinkTypes

setPermissionUserIdentityLinkTypes

getPermissionGroups

setPermissionGroups

getMappedStates

setMappedStates

getMappedSubStates

setMappedSubStates

getMappedTypes

setMappedTypes

getMappedSubTypes

setMappedSubTypes

getChannels

setChannels

getTheme

setTheme

getIcon

setIcon