com.flowable.action.engine.impl.persistence.entity

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 and Description
protected List<ActionDefinitionLink>	actionDefinitionLinks
protected boolean	actionDefinitionLinksInitialized
protected String	botKey
protected Date	creationTime
protected String	creatorId
protected String	deploymentId
protected String	formKey
protected boolean	global
protected List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>	identityLinks The identity links for the action definition.
protected boolean	identityLinksInitialized
protected String	key
protected boolean	mandatory
protected String	name
protected String	resourceName
protected String	scopeType
protected String	tenantId
protected String	updaterId
protected Date	updateTime
protected int	version

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Constructor Summary

Constructors

Constructor and Description
ActionDefinitionEntityImpl()

Method Summary

Modifier and Type	Method and Description
List<ActionDefinitionLink>	getActionDefinitionLinks() Returns the action definition links that are linked to the action definition.
String	getAssignedGroupId() Returns the id of the assigned group of this object.
String	getAssigneeId() Returns the id of the assignee of this object.
String	getBotKey() Returns the key of the bot this action is implemented.
Set<String>	getCandidateGroupIds() Returns a set view of the optional list of candidate group ids of this object.
Set<String>	getCandidateUserIds() Returns a set view of the optional list of candidate user ids of this object.
Date	getCreationTime() Returns the creation timestamp of this data object.
String	getCreatorId() Returns the id of the user creating this data object.
String	getDeploymentId()
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.
List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>	getIdentityLinks()
String	getKey()
String	getName() Returns the name of this action which is also used as the slash action name (e.g.
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.
Object	getPersistentState()
List<ActionDefinitionLink>	getQueryActionDefinitionLinks() Getter used by MyBatis when querying action definitions with action definition links.
List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>	getQueryIdentityLinks() Getter used by MyBatis when querying action definitions with identity links.
String	getResourceName()
String	getScopeType() Returns the type of scope if this action definition is bound to a certain type of scoped objects (e.g.
String	getTenantId()
String	getUpdaterId() Returns the optional id of the user having last modified this data object, if any, null otherwise.
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 be null.
int	getVersion()
boolean	isGlobal() Whether the action definition is global
boolean	isMandatory() Returns true 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(List<ActionDefinitionLink> actionDefinitionLinks)
void	setBotKey(String botKey)
void	setCreationTime(Date creationTime)
void	setCreatorId(String creatorId)
void	setDeploymentId(String deploymentId)
void	setFormKey(String formKey)
void	setGlobal(boolean global)
void	setIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
void	setKey(String key)
void	setMandatory(boolean mandatory)
void	setName(String name)
void	setQueryActionDefinitionLinks(List<ActionDefinitionLink> actionDefinitionLinks) Setter used by MyBatis when querying action definitions with action definition links.
void	setQueryIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks) Setter used by MyBatis when querying action definitions with identity links.
void	setResourceName(String resourceName)
void	setScopeType(String scopeType)
void	setTenantId(String tenantId)
void	setUpdaterId(String updaterId)
void	setUpdateTime(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

Methods inherited from interface com.flowable.action.api.repository.ActionDefinition

getId

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

getRevision, getRevisionNext, setRevision

Field Detail

key

protected String key

version

protected int version

deploymentId

protected String deploymentId

tenantId

protected String tenantId

botKey

protected String botKey

mandatory

protected boolean mandatory

name

protected String name

resourceName

protected String resourceName

scopeType

protected String scopeType

formKey

protected String formKey

global

protected boolean global

creationTime

protected Date creationTime

updateTime

protected Date updateTime

creatorId

protected String creatorId

updaterId

protected String updaterId

identityLinksInitialized

protected boolean identityLinksInitialized

actionDefinitionLinksInitialized

protected boolean actionDefinitionLinksInitialized

identityLinks

protected List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks

The identity links for the action definition. Make sure that it is not set otherwise MyBatis won't invoke the setter.

actionDefinitionLinks

protected List<ActionDefinitionLink> actionDefinitionLinks

Constructor Detail

ActionDefinitionEntityImpl

public ActionDefinitionEntityImpl()

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface ActionDefinition

setKey

public void setKey(String key)

Specified by:

setKey in interface ActionDefinitionEntity

getVersion

public int getVersion()

Specified by:

getVersion in interface ActionDefinition

setVersion

public void setVersion(int version)

Specified by:

setVersion in interface ActionDefinitionEntity

getDeploymentId

public String getDeploymentId()

Specified by:

getDeploymentId in interface ActionDefinition

setDeploymentId

public void setDeploymentId(String deploymentId)

Specified by:

setDeploymentId in interface ActionDefinitionEntity

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface ActionDefinition

setTenantId

public void setTenantId(String tenantId)

Specified by:

setTenantId in interface ActionDefinitionEntity

getBotKey

public 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 interface ActionDefinition

Returns:

the key of the bot to send the action to for processing

setBotKey

public void setBotKey(String botKey)

Specified by:

setBotKey in interface ActionDefinitionEntity

isMandatory

public boolean isMandatory()

Description copied from interface: ActionDefinition

Returns true 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 to false if not provided explicitly.

Specified by:

isMandatory in interface ActionDefinition

Returns:

true if this action definition is mandatory

setMandatory

public void setMandatory(boolean mandatory)

Specified by:

setMandatory in interface ActionDefinitionEntity

getName

public 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 interface ActionDefinition

Returns:

the name of the action

setName

public void setName(String name)

Specified by:

setName in interface ActionDefinitionEntity

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface ActionDefinition

setResourceName

public void setResourceName(String resourceName)

Specified by:

setResourceName in interface ActionDefinitionEntity

getScopeType

public 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 interface ActionDefinition

Returns:

the type of scoped objects this action definition is bound to

setScopeType

public void setScopeType(String scopeType)

Specified by:

setScopeType in interface ActionDefinitionEntity

getFormKey

public 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 interface ActionDefinition

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(String formKey)

Specified by:

setFormKey in interface ActionDefinitionEntity

isGlobal

public boolean isGlobal()

Description copied from interface: ActionDefinition

Whether the action definition is global

Specified by:

isGlobal in interface ActionDefinition

Returns:

true if the AD is global, false otherwise

setGlobal

public void setGlobal(boolean global)

Specified by:

setGlobal in interface ActionDefinitionEntity

getCreationTime

public Date getCreationTime()

Description copied from interface: ActionDefinition

Returns the creation timestamp of this data object.

Specified by:

getCreationTime in interface ActionDefinition

Returns:

the creation timestamp

setCreationTime

public void setCreationTime(Date creationTime)

Specified by:

setCreationTime in interface ActionDefinitionEntity

getUpdateTime

public 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 be null.

Specified by:

getUpdateTime in interface ActionDefinition

Returns:

the timestamp of the last update / modification of this data object

setUpdateTime

public void setUpdateTime(Date updateTime)

Specified by:

setUpdateTime in interface ActionDefinitionEntity

getCreatorId

public String getCreatorId()

Description copied from interface: ActionDefinition

Returns the id of the user creating this data object.

Specified by:

getCreatorId in interface ActionDefinition

Returns:

the id of the creation user

setCreatorId

public void setCreatorId(String creatorId)

Specified by:

setCreatorId in interface ActionDefinitionEntity

getUpdaterId

public 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 interface ActionDefinition

Returns:

the optional id of the user having last updated this data object

setUpdaterId

public void setUpdaterId(String updaterId)

Specified by:

setUpdaterId in interface ActionDefinitionEntity

getOwnerId

public 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 interface ActionDefinition

Returns:

the id of the user being the owner of this object

getAssigneeId

public 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 interface ActionDefinition

Returns:

the optional id of the user being the assignee of the object

getAssignedGroupId

public 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 interface ActionDefinition

Returns:

the id of the optional assigned group

getCandidateUserIds

public Set<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 interface ActionDefinition

Returns:

the optional list of candidate user ids attached to this object

getCandidateGroupIds

public Set<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 interface ActionDefinition

Returns:

the optional list of candidate group ids attached to this object

getIdentityLinks

public List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getIdentityLinks()

Specified by:

getIdentityLinks in interface ActionDefinitionEntity

setIdentityLinks

public void setIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)

Specified by:

setIdentityLinks in interface ActionDefinitionEntity

getQueryIdentityLinks

public 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(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)

Setter used by MyBatis when querying action definitions with identity links.

getActionDefinitionLinks

public List<ActionDefinitionLink> getActionDefinitionLinks()

Description copied from interface: ActionDefinition

Returns the action definition links that are linked to the action definition.

Specified by:

getActionDefinitionLinks in interface ActionDefinition

Returns:

the optional list of action definition links

setActionDefinitionLinks

public void setActionDefinitionLinks(List<ActionDefinitionLink> actionDefinitionLinks)

Specified by:

setActionDefinitionLinks in interface ActionDefinitionEntity

getQueryActionDefinitionLinks

public List<ActionDefinitionLink> getQueryActionDefinitionLinks()

Getter used by MyBatis when querying action definitions with action definition links.

setQueryActionDefinitionLinks

public void setQueryActionDefinitionLinks(List<ActionDefinitionLink> actionDefinitionLinks)

Setter used by MyBatis when querying action definitions with action definition links.

getPersistentState

public Object getPersistentState()

Specified by:

getPersistentState in interface org.flowable.common.engine.impl.persistence.entity.Entity