java.lang.Object

com.flowable.action.api.repository.BaseActionDefinitionModel

All Implemented Interfaces:: ActionDefinitionModel

public class BaseActionDefinitionModel
extends java.lang.Object
implements ActionDefinitionModel

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`botKey`
`protected java.util.List<java.lang.String>`	`channels`
`protected java.lang.String`	`confirmationMessage`
`protected java.lang.String`	`confirmationMessageCode`
`protected java.lang.String`	`confirmationTitle`
`protected java.lang.String`	`confirmationTitleCode`
`protected java.lang.String`	`description`
`protected java.lang.String`	`formKey`
`protected boolean`	`formSameDeployment`
`protected java.lang.Boolean`	`global`
`protected java.lang.String`	`groupId`
`protected java.lang.String`	`help`
`protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>`	`i18n`
`protected java.lang.String`	`icon`
`protected java.lang.Boolean`	`ignoreConfirmationMessage`
`protected java.lang.String`	`key`
`protected java.util.List<java.lang.String>`	`mappedStates`
`protected java.util.List<java.lang.String>`	`mappedSubStates`
`protected java.util.List<java.lang.String>`	`mappedSubTypes`
`protected java.util.List<java.lang.String>`	`mappedTypes`
`protected java.lang.String`	`name`
`protected java.util.List<java.lang.String>`	`permissionGroups`
`protected java.util.Set<java.lang.String>`	`permissionUserIdentityLinkTypes`
`protected java.lang.Integer`	`priority`
`protected java.lang.String`	`sample`
`protected java.lang.String`	`scopeType`
`protected java.lang.String`	`signalName`
`protected java.util.List<java.lang.String>`	`signalVariableNames`
`protected java.lang.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

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()`
`void`	`setBotKey(java.lang.String botKey)`
`void`	`setChannels(java.util.List<java.lang.String> channels)`
`void`	`setConfirmationMessage(java.lang.String confirmationMessage)`
`void`	`setConfirmationMessageCode(java.lang.String confirmationMessageCode)`
`void`	`setConfirmationTitle(java.lang.String confirmationTitle)`
`void`	`setConfirmationTitleCode(java.lang.String confirmationTitleCode)`
`void`	`setDescription(java.lang.String description)`
`void`	`setFormKey(java.lang.String formKey)`
`void`	`setFormSameDeployment(boolean formSameDeployment)`
`void`	`setGlobal(java.lang.Boolean global)`
`void`	`setGroupId(java.lang.String groupId)`
`void`	`setHelp(java.lang.String help)`
`void`	`setI18n(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> i18n)`
`void`	`setIcon(java.lang.String icon)`
`void`	`setIgnoreConfirmationMessage(java.lang.Boolean ignoreConfirmationMessage)`
`void`	`setKey(java.lang.String key)`
`void`	`setMappedStates(java.util.List<java.lang.String> mappedStates)`
`void`	`setMappedSubStates(java.util.List<java.lang.String> mappedSubStates)`
`void`	`setMappedSubTypes(java.util.List<java.lang.String> mappedSubTypes)`
`void`	`setMappedTypes(java.util.List<java.lang.String> mappedTypes)`
`void`	`setName(java.lang.String name)`
`void`	`setPermissionGroups(java.util.List<java.lang.String> permissionGroups)`
`void`	`setPermissionUserIdentityLinkTypes(java.util.Set<java.lang.String> permissionUserIdentityLinkTypes)`
`void`	`setPriority(java.lang.Integer priority)`
`void`	`setSample(java.lang.String sample)`
`void`	`setScopeType(java.lang.String scopeType)`
`void`	`setSignalName(java.lang.String signalName)`
`void`	`setSignalVariableNames(java.util.List<java.lang.String> signalVariableNames)`
`void`	`setTheme(java.lang.String theme)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- key
  
  protected java.lang.String key
- name
  
  protected java.lang.String name
- description
  
  protected java.lang.String description
- formKey
  
  protected java.lang.String formKey
- formSameDeployment
  
  protected boolean formSameDeployment
- confirmationMessage
  
  protected java.lang.String confirmationMessage
- confirmationMessageCode
  
  protected java.lang.String confirmationMessageCode
- confirmationTitle
  
  protected java.lang.String confirmationTitle
- confirmationTitleCode
  
  protected java.lang.String confirmationTitleCode
- ignoreConfirmationMessage
  
  protected java.lang.Boolean ignoreConfirmationMessage
- scopeType
  
  protected java.lang.String scopeType
- permissionUserIdentityLinkTypes
  
  protected java.util.Set<java.lang.String> permissionUserIdentityLinkTypes
- permissionGroups
  
  protected java.util.List<java.lang.String> permissionGroups
- mappedStates
  
  protected java.util.List<java.lang.String> mappedStates
- mappedSubStates
  
  protected java.util.List<java.lang.String> mappedSubStates
- mappedTypes
  
  protected java.util.List<java.lang.String> mappedTypes
- mappedSubTypes
  
  protected java.util.List<java.lang.String> mappedSubTypes
- channels
  
  protected java.util.List<java.lang.String> channels
- theme
  
  protected java.lang.String theme
- icon
  
  protected java.lang.String icon
- priority
  
  protected java.lang.Integer priority
- groupId
  
  protected java.lang.String groupId
- sample
  
  protected java.lang.String sample
- help
  
  protected java.lang.String help
- global
  
  protected java.lang.Boolean global
- botKey
  
  protected java.lang.String botKey
- signalName
  
  protected java.lang.String signalName
- signalVariableNames
  
  protected java.util.List<java.lang.String> signalVariableNames
- i18n
  
  protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> i18n
Constructor Details
- BaseActionDefinitionModel
  
  public BaseActionDefinitionModel()
Method Details
- getKey
  
  public java.lang.String getKey()
  
  Specified by:
  
  getKey in interface ActionDefinitionModel
- setKey
  
  public void setKey(java.lang.String key)
- getName
  
  public java.lang.String getName()
  
  Specified by:
  
  getName in interface ActionDefinitionModel
- setName
  
  public void setName(java.lang.String name)
- getDescription
  
  public java.lang.String getDescription()
  
  Specified by:
  
  getDescription in interface ActionDefinitionModel
- setDescription
  
  public void setDescription(java.lang.String description)
- getFormKey
  
  public java.lang.String getFormKey()
  
  Specified by:
  
  getFormKey in interface ActionDefinitionModel
- setFormKey
  
  public void setFormKey(java.lang.String formKey)
- isFormSameDeployment
  
  public boolean isFormSameDeployment()
  
  Specified by:
  
  isFormSameDeployment in interface ActionDefinitionModel
- setFormSameDeployment
  
  public void setFormSameDeployment(boolean formSameDeployment)
- getConfirmationMessage
  
  public java.lang.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(java.lang.String confirmationMessage)
- getConfirmationMessageCode
  
  public java.lang.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(java.lang.String confirmationMessageCode)
- getConfirmationTitle
  
  public java.lang.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(java.lang.String confirmationTitle)
- getConfirmationTitleCode
  
  public java.lang.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(java.lang.String confirmationTitleCode)
- getIgnoreConfirmationMessage
  
  public java.lang.Boolean getIgnoreConfirmationMessage()
  
  Specified by:
  
  getIgnoreConfirmationMessage in interface ActionDefinitionModel
- setIgnoreConfirmationMessage
  
  public void setIgnoreConfirmationMessage(java.lang.Boolean ignoreConfirmationMessage)
- getScopeType
  
  public java.lang.String getScopeType()
  
  Specified by:
  
  getScopeType in interface ActionDefinitionModel
- setScopeType
  
  public void setScopeType(java.lang.String scopeType)
- getPermissionUserIdentityLinkTypes
  
  public java.util.Set<java.lang.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(java.util.Set<java.lang.String> permissionUserIdentityLinkTypes)
- getPermissionGroups
  
  public java.util.List<java.lang.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(java.util.List<java.lang.String> permissionGroups)
- getMappedStates
  
  public java.util.List<java.lang.String> getMappedStates()
  
  Specified by:
  
  getMappedStates in interface ActionDefinitionModel
- setMappedStates
  
  public void setMappedStates(java.util.List<java.lang.String> mappedStates)
- getMappedSubStates
  
  public java.util.List<java.lang.String> getMappedSubStates()
  
  Specified by:
  
  getMappedSubStates in interface ActionDefinitionModel
- setMappedSubStates
  
  public void setMappedSubStates(java.util.List<java.lang.String> mappedSubStates)
- getMappedTypes
  
  public java.util.List<java.lang.String> getMappedTypes()
  
  Specified by:
  
  getMappedTypes in interface ActionDefinitionModel
- setMappedTypes
  
  public void setMappedTypes(java.util.List<java.lang.String> mappedTypes)
- getMappedSubTypes
  
  public java.util.List<java.lang.String> getMappedSubTypes()
  
  Specified by:
  
  getMappedSubTypes in interface ActionDefinitionModel
- setMappedSubTypes
  
  public void setMappedSubTypes(java.util.List<java.lang.String> mappedSubTypes)
- getChannels
  
  public java.util.List<java.lang.String> getChannels()
  
  Specified by:
  
  getChannels in interface ActionDefinitionModel
- setChannels
  
  public void setChannels(java.util.List<java.lang.String> channels)
- getTheme
  
  public java.lang.String getTheme()
  
  Specified by:
  
  getTheme in interface ActionDefinitionModel
- setTheme
  
  public void setTheme(java.lang.String theme)
- getIcon
  
  public java.lang.String getIcon()
  
  Specified by:
  
  getIcon in interface ActionDefinitionModel
- setIcon
  
  public void setIcon(java.lang.String icon)
- getPriority
  
  public java.lang.Integer getPriority()
  
  Specified by:
  
  getPriority in interface ActionDefinitionModel
- setPriority
  
  public void setPriority(java.lang.Integer priority)
- getGroupId
  
  public java.lang.String getGroupId()
  
  Specified by:
  
  getGroupId in interface ActionDefinitionModel
- setGroupId
  
  public void setGroupId(java.lang.String groupId)
- getSample
  
  public java.lang.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(java.lang.String sample)
- getHelp
  
  public java.lang.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(java.lang.String help)
- getGlobal
  
  public java.lang.Boolean getGlobal()
  
  Specified by:
  
  getGlobal in interface ActionDefinitionModel
- setGlobal
  
  public void setGlobal(java.lang.Boolean global)
- getBotKey
  
  public java.lang.String getBotKey()
  
  Specified by:
  
  getBotKey in interface ActionDefinitionModel
- setBotKey
  
  public void setBotKey(java.lang.String botKey)
- getSignalName
  
  public java.lang.String getSignalName()
  
  Specified by:
  
  getSignalName in interface ActionDefinitionModel
- setSignalName
  
  public void setSignalName(java.lang.String signalName)
- getSignalVariableNames
  
  public java.util.List<java.lang.String> getSignalVariableNames()
  
  Specified by:
  
  getSignalVariableNames in interface ActionDefinitionModel
- setSignalVariableNames
  
  public void setSignalVariableNames(java.util.List<java.lang.String> signalVariableNames)
- getI18n
  
  public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getI18n()
  
  Specified by:
  
  getI18n in interface ActionDefinitionModel
- setI18n
  
  public void setI18n(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> i18n)

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 Details

Constructor Details

Method Details