Class ActionDefinitionEntityImpl
java.lang.Object
org.flowable.common.engine.impl.persistence.entity.AbstractEntity
com.flowable.action.engine.impl.persistence.entity.AbstractActionEngineEntity
com.flowable.action.engine.impl.persistence.entity.ActionDefinitionEntityImpl
- All Implemented Interfaces:
ActionDefinition
,ActionDefinitionEntity
,org.flowable.common.engine.impl.db.HasRevision
,org.flowable.common.engine.impl.persistence.entity.Entity
public class ActionDefinitionEntityImpl extends AbstractActionEngineEntity implements ActionDefinitionEntity
- Author:
- Filip Hrisafov
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<ActionDefinitionLink>
actionDefinitionLinks
protected boolean
actionDefinitionLinksInitialized
protected java.lang.String
botKey
protected java.util.Date
creationTime
protected java.lang.String
creatorId
protected java.lang.String
deploymentId
protected java.lang.String
formKey
protected boolean
global
protected java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>
identityLinks
The identity links for the action definition.protected boolean
identityLinksInitialized
protected java.lang.String
key
protected boolean
mandatory
protected java.lang.String
name
protected java.lang.String
resourceName
protected java.lang.String
scopeType
protected java.lang.String
tenantId
protected java.lang.String
updaterId
protected java.util.Date
updateTime
protected int
version
-
Constructor Summary
Constructors Constructor Description ActionDefinitionEntityImpl()
-
Method Summary
Modifier and Type Method Description java.util.List<ActionDefinitionLink>
getActionDefinitionLinks()
Returns the action definition links that are linked to the action definition.java.lang.String
getAssignedGroupId()
Returns the id of the assigned group of this object.java.lang.String
getAssigneeId()
Returns the id of the assignee of this object.java.lang.String
getBotKey()
Returns the key of the bot this action is implemented.java.util.Set<java.lang.String>
getCandidateGroupIds()
Returns a set view of the optional list of candidate group ids of this object.java.util.Set<java.lang.String>
getCandidateUserIds()
Returns a set view of the optional list of candidate user ids of this object.java.util.Date
getCreationTime()
Returns the creation timestamp of this data object.java.lang.String
getCreatorId()
Returns the id of the user creating this data object.java.lang.String
getDeploymentId()
java.lang.String
getFormKey()
If this action has an attached form definition, this method returns the form key of it with which the form definition might be requested through Form Engine.java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>
getIdentityLinks()
java.lang.String
getKey()
java.lang.String
getName()
Returns the name of this action which is also used as the slash action name (e.g.java.lang.String
getOwnerId()
Returns the id of the owner of this object, most likely representing the user actually creating it or being created as part of an operation that user executed.java.lang.Object
getPersistentState()
java.util.List<ActionDefinitionLink>
getQueryActionDefinitionLinks()
Getter used by MyBatis when querying action definitions with action definition links.java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>
getQueryIdentityLinks()
Getter used by MyBatis when querying action definitions with identity links.java.lang.String
getResourceName()
java.lang.String
getScopeType()
Returns the type of scope if this action definition is bound to a certain type of scoped objects (e.g.java.lang.String
getTenantId()
java.lang.String
getUpdaterId()
Returns the optional id of the user having last modified this data object, if any,null
otherwise.java.util.Date
getUpdateTime()
Returns the timestamp of the last update of this data object, in most cases where events are immutable, this timestamp is the same as the creation timestamp, but must never benull
.int
getVersion()
boolean
isGlobal()
Whether the action definition is globalboolean
isMandatory()
Returnstrue
if this is a mandatory action definition, which means it has to be executed (as an action) at some point (most likely it is then backed by a user task or anything which needs to be completed somehow).void
setActionDefinitionLinks(java.util.List<ActionDefinitionLink> actionDefinitionLinks)
void
setBotKey(java.lang.String botKey)
void
setCreationTime(java.util.Date creationTime)
void
setCreatorId(java.lang.String creatorId)
void
setDeploymentId(java.lang.String deploymentId)
void
setFormKey(java.lang.String formKey)
void
setGlobal(boolean global)
void
setIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
void
setKey(java.lang.String key)
void
setMandatory(boolean mandatory)
void
setName(java.lang.String name)
void
setQueryActionDefinitionLinks(java.util.List<ActionDefinitionLink> actionDefinitionLinks)
Setter used by MyBatis when querying action definitions with action definition links.void
setQueryIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
Setter used by MyBatis when querying action definitions with identity links.void
setResourceName(java.lang.String resourceName)
void
setScopeType(java.lang.String scopeType)
void
setTenantId(java.lang.String tenantId)
void
setUpdaterId(java.lang.String updaterId)
void
setUpdateTime(java.util.Date updateTime)
void
setVersion(int version)
Methods inherited from class com.flowable.action.engine.impl.persistence.entity.AbstractActionEngineEntity
getIdPrefix
Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated
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 -
version
protected int version -
deploymentId
protected java.lang.String deploymentId -
tenantId
protected java.lang.String tenantId -
botKey
protected java.lang.String botKey -
mandatory
protected boolean mandatory -
name
protected java.lang.String name -
resourceName
protected java.lang.String resourceName -
scopeType
protected java.lang.String scopeType -
formKey
protected java.lang.String formKey -
global
protected boolean global -
creationTime
protected java.util.Date creationTime -
updateTime
protected java.util.Date updateTime -
creatorId
protected java.lang.String creatorId -
updaterId
protected java.lang.String updaterId -
identityLinksInitialized
protected boolean identityLinksInitialized -
actionDefinitionLinksInitialized
protected boolean actionDefinitionLinksInitialized -
identityLinks
protected java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinksThe identity links for the action definition. Make sure that it is not set otherwise MyBatis won't invoke the setter. -
actionDefinitionLinks
-
-
Constructor Details
-
ActionDefinitionEntityImpl
public ActionDefinitionEntityImpl()
-
-
Method Details
-
getKey
public java.lang.String getKey()- Specified by:
getKey
in interfaceActionDefinition
-
setKey
public void setKey(java.lang.String key)- Specified by:
setKey
in interfaceActionDefinitionEntity
-
getVersion
public int getVersion()- Specified by:
getVersion
in interfaceActionDefinition
-
setVersion
public void setVersion(int version)- Specified by:
setVersion
in interfaceActionDefinitionEntity
-
getDeploymentId
public java.lang.String getDeploymentId()- Specified by:
getDeploymentId
in interfaceActionDefinition
-
setDeploymentId
public void setDeploymentId(java.lang.String deploymentId)- Specified by:
setDeploymentId
in interfaceActionDefinitionEntity
-
getTenantId
public java.lang.String getTenantId()- Specified by:
getTenantId
in interfaceActionDefinition
-
setTenantId
public void setTenantId(java.lang.String tenantId)- Specified by:
setTenantId
in interfaceActionDefinitionEntity
-
getBotKey
public java.lang.String getBotKey()Description copied from interface:ActionDefinition
Returns the key of the bot this action is implemented. When receiving an action, the bot will be looked up and send the action there for processing.- Specified by:
getBotKey
in interfaceActionDefinition
- Returns:
- the key of the bot to send the action to for processing
-
setBotKey
public void setBotKey(java.lang.String botKey)- Specified by:
setBotKey
in interfaceActionDefinitionEntity
-
isMandatory
public boolean isMandatory()Description copied from interface:ActionDefinition
Returnstrue
if this is a mandatory action definition, which means it has to be executed (as an action) at some point (most likely it is then backed by a user task or anything which needs to be completed somehow). This is an optional flag and defaults tofalse
if not provided explicitly.- Specified by:
isMandatory
in interfaceActionDefinition
- Returns:
true
if this action definition is mandatory
-
setMandatory
public void setMandatory(boolean mandatory)- Specified by:
setMandatory
in interfaceActionDefinitionEntity
-
getName
public java.lang.String getName()Description copied from interface:ActionDefinition
Returns the name of this action which is also used as the slash action name (e.g. name 'foo' would be exposed within a conversation with '/foo' to execute it).- Specified by:
getName
in interfaceActionDefinition
- Returns:
- the name of the action
-
setName
public void setName(java.lang.String name)- Specified by:
setName
in interfaceActionDefinitionEntity
-
getResourceName
public java.lang.String getResourceName()- Specified by:
getResourceName
in interfaceActionDefinition
-
setResourceName
public void setResourceName(java.lang.String resourceName)- Specified by:
setResourceName
in interfaceActionDefinitionEntity
-
getScopeType
public java.lang.String getScopeType()Description copied from interface:ActionDefinition
Returns the type of scope if this action definition is bound to a certain type of scoped objects (e.g. conversation, user, etc).- Specified by:
getScopeType
in interfaceActionDefinition
- Returns:
- the type of scoped objects this action definition is bound to
-
setScopeType
public void setScopeType(java.lang.String scopeType)- Specified by:
setScopeType
in interfaceActionDefinitionEntity
-
getFormKey
public java.lang.String getFormKey()Description copied from interface:ActionDefinition
If this action has an attached form definition, this method returns the form key of it with which the form definition might be requested through Form Engine.- Specified by:
getFormKey
in interfaceActionDefinition
- Returns:
- the key of the form to be used to render this action definition and get input to create an action object
-
setFormKey
public void setFormKey(java.lang.String formKey)- Specified by:
setFormKey
in interfaceActionDefinitionEntity
-
isGlobal
public boolean isGlobal()Description copied from interface:ActionDefinition
Whether the action definition is global- Specified by:
isGlobal
in interfaceActionDefinition
- Returns:
true
if the AD is global,false
otherwise
-
setGlobal
public void setGlobal(boolean global)- Specified by:
setGlobal
in interfaceActionDefinitionEntity
-
getCreationTime
public java.util.Date getCreationTime()Description copied from interface:ActionDefinition
Returns the creation timestamp of this data object.- Specified by:
getCreationTime
in interfaceActionDefinition
- Returns:
- the creation timestamp
-
setCreationTime
public void setCreationTime(java.util.Date creationTime)- Specified by:
setCreationTime
in interfaceActionDefinitionEntity
-
getUpdateTime
public java.util.Date getUpdateTime()Description copied from interface:ActionDefinition
Returns the timestamp of the last update of this data object, in most cases where events are immutable, this timestamp is the same as the creation timestamp, but must never benull
.- Specified by:
getUpdateTime
in interfaceActionDefinition
- Returns:
- the timestamp of the last update / modification of this data object
-
setUpdateTime
public void setUpdateTime(java.util.Date updateTime)- Specified by:
setUpdateTime
in interfaceActionDefinitionEntity
-
getCreatorId
public java.lang.String getCreatorId()Description copied from interface:ActionDefinition
Returns the id of the user creating this data object.- Specified by:
getCreatorId
in interfaceActionDefinition
- Returns:
- the id of the creation user
-
setCreatorId
public void setCreatorId(java.lang.String creatorId)- Specified by:
setCreatorId
in interfaceActionDefinitionEntity
-
getUpdaterId
public java.lang.String getUpdaterId()Description copied from interface:ActionDefinition
Returns the optional id of the user having last modified this data object, if any,null
otherwise.- Specified by:
getUpdaterId
in interfaceActionDefinition
- Returns:
- the optional id of the user having last updated this data object
-
setUpdaterId
public void setUpdaterId(java.lang.String updaterId)- Specified by:
setUpdaterId
in interfaceActionDefinitionEntity
-
getOwnerId
public java.lang.String getOwnerId()Description copied from interface:ActionDefinition
Returns the id of the owner of this object, most likely representing the user actually creating it or being created as part of an operation that user executed.- Specified by:
getOwnerId
in interfaceActionDefinition
- Returns:
- the id of the user being the owner of this object
-
getAssigneeId
public java.lang.String getAssigneeId()Description copied from interface:ActionDefinition
Returns the id of the assignee of this object. What the assignee actually represents is up to the objects use cases and implementation.- Specified by:
getAssigneeId
in interfaceActionDefinition
- Returns:
- the optional id of the user being the assignee of the object
-
getAssignedGroupId
public java.lang.String getAssignedGroupId()Description copied from interface:ActionDefinition
Returns the id of the assigned group of this object. What the assigned group actually represents is up to the objects use cases and implementation.- Specified by:
getAssignedGroupId
in interfaceActionDefinition
- Returns:
- the id of the optional assigned group
-
getCandidateUserIds
public java.util.Set<java.lang.String> getCandidateUserIds()Description copied from interface:ActionDefinition
Returns a set view of the optional list of candidate user ids of this object. In most cases, this is used to allow access to the object for a selected list of users.- Specified by:
getCandidateUserIds
in interfaceActionDefinition
- Returns:
- the optional list of candidate user ids attached to this object
-
getCandidateGroupIds
public java.util.Set<java.lang.String> getCandidateGroupIds()Description copied from interface:ActionDefinition
Returns a set view of the optional list of candidate group ids of this object. Like with the list of candidate users, all users being at least a member of one of the candidate groups will also have access to this object.- Specified by:
getCandidateGroupIds
in interfaceActionDefinition
- Returns:
- the optional list of candidate group ids attached to this object
-
getIdentityLinks
public java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getIdentityLinks()- Specified by:
getIdentityLinks
in interfaceActionDefinitionEntity
-
setIdentityLinks
public void setIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)- Specified by:
setIdentityLinks
in interfaceActionDefinitionEntity
-
getQueryIdentityLinks
public java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getQueryIdentityLinks()Getter used by MyBatis when querying action definitions with identity links. -
setQueryIdentityLinks
public void setQueryIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)Setter used by MyBatis when querying action definitions with identity links. -
getActionDefinitionLinks
Description copied from interface:ActionDefinition
Returns the action definition links that are linked to the action definition.- Specified by:
getActionDefinitionLinks
in interfaceActionDefinition
- Returns:
- the optional list of action definition links
-
setActionDefinitionLinks
- Specified by:
setActionDefinitionLinks
in interfaceActionDefinitionEntity
-
getQueryActionDefinitionLinks
Getter used by MyBatis when querying action definitions with action definition links. -
setQueryActionDefinitionLinks
public void setQueryActionDefinitionLinks(java.util.List<ActionDefinitionLink> actionDefinitionLinks)Setter used by MyBatis when querying action definitions with action definition links. -
getPersistentState
public java.lang.Object getPersistentState()- Specified by:
getPersistentState
in interfaceorg.flowable.common.engine.impl.persistence.entity.Entity
-