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>actionDefinitionLinksprotected booleanactionDefinitionLinksInitializedprotected java.lang.StringbotKeyprotected java.util.DatecreationTimeprotected java.lang.StringcreatorIdprotected java.lang.StringdeploymentIdprotected java.lang.StringformKeyprotected booleanglobalprotected java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>identityLinksThe identity links for the action definition.protected booleanidentityLinksInitializedprotected java.lang.Stringkeyprotected booleanmandatoryprotected java.lang.Stringnameprotected java.lang.StringresourceNameprotected java.lang.StringscopeTypeprotected java.lang.StringtenantIdprotected java.lang.StringupdaterIdprotected java.util.DateupdateTimeprotected intversion -
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.StringgetAssignedGroupId()Returns the id of the assigned group of this object.java.lang.StringgetAssigneeId()Returns the id of the assignee of this object.java.lang.StringgetBotKey()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.DategetCreationTime()Returns the creation timestamp of this data object.java.lang.StringgetCreatorId()Returns the id of the user creating this data object.java.lang.StringgetDeploymentId()java.lang.StringgetFormKey()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.StringgetKey()java.lang.StringgetName()Returns the name of this action which is also used as the slash action name (e.g.java.lang.StringgetOwnerId()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.ObjectgetPersistentState()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.StringgetResourceName()java.lang.StringgetScopeType()Returns the type of scope if this action definition is bound to a certain type of scoped objects (e.g.java.lang.StringgetTenantId()java.lang.StringgetUpdaterId()Returns the optional id of the user having last modified this data object, if any,nullotherwise.java.util.DategetUpdateTime()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.intgetVersion()booleanisGlobal()Whether the action definition is globalbooleanisMandatory()Returnstrueif 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).voidsetActionDefinitionLinks(java.util.List<ActionDefinitionLink> actionDefinitionLinks)voidsetBotKey(java.lang.String botKey)voidsetCreationTime(java.util.Date creationTime)voidsetCreatorId(java.lang.String creatorId)voidsetDeploymentId(java.lang.String deploymentId)voidsetFormKey(java.lang.String formKey)voidsetGlobal(boolean global)voidsetIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)voidsetKey(java.lang.String key)voidsetMandatory(boolean mandatory)voidsetName(java.lang.String name)voidsetQueryActionDefinitionLinks(java.util.List<ActionDefinitionLink> actionDefinitionLinks)Setter used by MyBatis when querying action definitions with action definition links.voidsetQueryIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)Setter used by MyBatis when querying action definitions with identity links.voidsetResourceName(java.lang.String resourceName)voidsetScopeType(java.lang.String scopeType)voidsetTenantId(java.lang.String tenantId)voidsetUpdaterId(java.lang.String updaterId)voidsetUpdateTime(java.util.Date updateTime)voidsetVersion(int version)Methods inherited from class com.flowable.action.engine.impl.persistence.entity.AbstractActionEngineEntity
getIdPrefixMethods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdatedMethods 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:
getKeyin interfaceActionDefinition
-
setKey
public void setKey(java.lang.String key)- Specified by:
setKeyin interfaceActionDefinitionEntity
-
getVersion
public int getVersion()- Specified by:
getVersionin interfaceActionDefinition
-
setVersion
public void setVersion(int version)- Specified by:
setVersionin interfaceActionDefinitionEntity
-
getDeploymentId
public java.lang.String getDeploymentId()- Specified by:
getDeploymentIdin interfaceActionDefinition
-
setDeploymentId
public void setDeploymentId(java.lang.String deploymentId)- Specified by:
setDeploymentIdin interfaceActionDefinitionEntity
-
getTenantId
public java.lang.String getTenantId()- Specified by:
getTenantIdin interfaceActionDefinition
-
setTenantId
public void setTenantId(java.lang.String tenantId)- Specified by:
setTenantIdin interfaceActionDefinitionEntity
-
getBotKey
public java.lang.String getBotKey()Description copied from interface:ActionDefinitionReturns 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:
getBotKeyin interfaceActionDefinition- Returns:
- the key of the bot to send the action to for processing
-
setBotKey
public void setBotKey(java.lang.String botKey)- Specified by:
setBotKeyin interfaceActionDefinitionEntity
-
isMandatory
public boolean isMandatory()Description copied from interface:ActionDefinitionReturnstrueif 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 tofalseif not provided explicitly.- Specified by:
isMandatoryin interfaceActionDefinition- Returns:
trueif this action definition is mandatory
-
setMandatory
public void setMandatory(boolean mandatory)- Specified by:
setMandatoryin interfaceActionDefinitionEntity
-
getName
public java.lang.String getName()Description copied from interface:ActionDefinitionReturns 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:
getNamein interfaceActionDefinition- Returns:
- the name of the action
-
setName
public void setName(java.lang.String name)- Specified by:
setNamein interfaceActionDefinitionEntity
-
getResourceName
public java.lang.String getResourceName()- Specified by:
getResourceNamein interfaceActionDefinition
-
setResourceName
public void setResourceName(java.lang.String resourceName)- Specified by:
setResourceNamein interfaceActionDefinitionEntity
-
getScopeType
public java.lang.String getScopeType()Description copied from interface:ActionDefinitionReturns the type of scope if this action definition is bound to a certain type of scoped objects (e.g. conversation, user, etc).- Specified by:
getScopeTypein interfaceActionDefinition- Returns:
- the type of scoped objects this action definition is bound to
-
setScopeType
public void setScopeType(java.lang.String scopeType)- Specified by:
setScopeTypein interfaceActionDefinitionEntity
-
getFormKey
public java.lang.String getFormKey()Description copied from interface:ActionDefinitionIf 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:
getFormKeyin 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:
setFormKeyin interfaceActionDefinitionEntity
-
isGlobal
public boolean isGlobal()Description copied from interface:ActionDefinitionWhether the action definition is global- Specified by:
isGlobalin interfaceActionDefinition- Returns:
trueif the AD is global,falseotherwise
-
setGlobal
public void setGlobal(boolean global)- Specified by:
setGlobalin interfaceActionDefinitionEntity
-
getCreationTime
public java.util.Date getCreationTime()Description copied from interface:ActionDefinitionReturns the creation timestamp of this data object.- Specified by:
getCreationTimein interfaceActionDefinition- Returns:
- the creation timestamp
-
setCreationTime
public void setCreationTime(java.util.Date creationTime)- Specified by:
setCreationTimein interfaceActionDefinitionEntity
-
getUpdateTime
public java.util.Date getUpdateTime()Description copied from interface:ActionDefinitionReturns 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:
getUpdateTimein interfaceActionDefinition- Returns:
- the timestamp of the last update / modification of this data object
-
setUpdateTime
public void setUpdateTime(java.util.Date updateTime)- Specified by:
setUpdateTimein interfaceActionDefinitionEntity
-
getCreatorId
public java.lang.String getCreatorId()Description copied from interface:ActionDefinitionReturns the id of the user creating this data object.- Specified by:
getCreatorIdin interfaceActionDefinition- Returns:
- the id of the creation user
-
setCreatorId
public void setCreatorId(java.lang.String creatorId)- Specified by:
setCreatorIdin interfaceActionDefinitionEntity
-
getUpdaterId
public java.lang.String getUpdaterId()Description copied from interface:ActionDefinitionReturns the optional id of the user having last modified this data object, if any,nullotherwise.- Specified by:
getUpdaterIdin interfaceActionDefinition- Returns:
- the optional id of the user having last updated this data object
-
setUpdaterId
public void setUpdaterId(java.lang.String updaterId)- Specified by:
setUpdaterIdin interfaceActionDefinitionEntity
-
getOwnerId
public java.lang.String getOwnerId()Description copied from interface:ActionDefinitionReturns 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:
getOwnerIdin interfaceActionDefinition- Returns:
- the id of the user being the owner of this object
-
getAssigneeId
public java.lang.String getAssigneeId()Description copied from interface:ActionDefinitionReturns the id of the assignee of this object. What the assignee actually represents is up to the objects use cases and implementation.- Specified by:
getAssigneeIdin interfaceActionDefinition- Returns:
- the optional id of the user being the assignee of the object
-
getAssignedGroupId
public java.lang.String getAssignedGroupId()Description copied from interface:ActionDefinitionReturns 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:
getAssignedGroupIdin interfaceActionDefinition- Returns:
- the id of the optional assigned group
-
getCandidateUserIds
public java.util.Set<java.lang.String> getCandidateUserIds()Description copied from interface:ActionDefinitionReturns 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:
getCandidateUserIdsin 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:ActionDefinitionReturns 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:
getCandidateGroupIdsin 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:
getIdentityLinksin interfaceActionDefinitionEntity
-
setIdentityLinks
public void setIdentityLinks(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)- Specified by:
setIdentityLinksin 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:ActionDefinitionReturns the action definition links that are linked to the action definition.- Specified by:
getActionDefinitionLinksin interfaceActionDefinition- Returns:
- the optional list of action definition links
-
setActionDefinitionLinks
- Specified by:
setActionDefinitionLinksin 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:
getPersistentStatein interfaceorg.flowable.common.engine.impl.persistence.entity.Entity
-